Search for course assignments
- 16 Jul 2024
- 4 Minutes to read
- Print
Search for course assignments
- Updated on 16 Jul 2024
- 4 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchCourseAssignments
Allows you to search for course assignments.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
The value you want to sort by
userId
integer (int32)
An optional parameter used to filter for course assignments for a particular user
userExternalId
string
An optional parameter used to filter for course assignments for a particular user using an external identifier
courseId
integer (int32)
An optional parameter used to filter for course assignments for a particular course
completionStatus
integer (int32)
An optional parameter used to filter for course assignments with a particular completion status. Possible values:
- 0 = Not Started
- 10 = Incomplete
- 20 = Not Started or Incomplete
- 30 = Complete
createdAfter
integer (int64)
An optional parameter used to filter for course assignments created after a specified date. When used in conjunction with the "createdBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
createdBefore
integer (int64)
An optional parameter used to filter for course assignments created before a specified date. When used in conjunction with the "createdAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
expiresAfter
integer (int64)
An optional parameter used to filter for course assignments that expire after a specified date. When used in conjunction with the "expiresBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
expiresBefore
integer (int64)
An optional parameter used to filter for course assignments that expire before a specified date. When used in conjunction with the "expiresAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
startedAfter
integer (int64)
An optional parameter used to filter for course assignments started after a specified date. When used in conjunction with the "startedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
startedBefore
integer (int64)
An optional parameter used to filter for course assignments started before a specified date. When used in conjunction with the "startedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
completedAfter
integer (int64)
An optional parameter used to filter for course assignments completed after a specified date. When used in conjunction with the "completedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
completedBefore
integer (int64)
An optional parameter used to filter for course assignments completed before a specified date. When used in conjunction with the "completedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Results
Array of object (CourseAssignmentSearchResult)
See CourseAssignmentSearchResult
object
Id
integer (int32)
The course assignment's unique identifier
Example12345
ExternalId
string | null
The course assignment's external ID, usually a unique identifier from the calling system
ExampleFC8D0166
CourseId
integer (int32)
The course's unique identifier
Example1234
CourseName
string
The name of the course
ExampleCourse name sample
UserId
integer (int32)
The user's unique identifier
Example190615
UserExternalId
string | null
The user's external ID, usually a unique identifier from the calling system
Example89CFAB18-443D-495C-89B0-95A85E0A00BA
FirstName
string
The user's first name
ExampleSally
LastName
string
The user's last name
ExampleDoe
Email
string
The user's e-mail address
Examplesally.doe@sample.net
OrganizationId
integer (int32)
The unique identifier of the organization the user belongs to
Example2471
PaymentType
string
What type of key was used to get access to the course
ExampleSubscription (Microsoft Total Access Collection)
Created
integer (int64)
When the course assignment was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1295375536
Expires
integer (int64) | null
When the course assignment expires. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1310947200
Started
integer (int64) | null
When the course assignment was started by the user. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1295378841
Completed
integer (int64) | null
When the course assignment was completed by the user. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
Example1295386048
Was this article helpful?