Retrieve course assignment information by id
- 16 Jul 2024
- 1 Minute to read
- Print
Retrieve course assignment information by id
- Updated on 16 Jul 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/GetCourseAssignment/{id}
Allows you to get information about a course assignment.
Security
API Key
Header parameter nameapi_key
Path parameters
id
integer (int32) Required
The ID of the course assignment to retrieve
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).
Results
Array of object (CourseAssignment)
See CourseAssignment
object
Id
integer (int32)
The course assignment's unique identifier
Example1234
ExternalId
string | null
The course assignment's external ID, usually a unique identifier from the calling system
ExampleC9876ZFGEFER9876
CourseId
integer (int32)
The Id of the course associated with this course assignment.
Example123
UserId
integer (int32)
The UserId of the user that is associated with this course assignment.
Example3434
ClubMembershipId
integer (int32) | null
The subscription (if any) associated with this course assignment.
Example119955
Expire
integer (int64) | null
When the course assignment expires (if ever) (in Unix epoch time)
Example1450479600
TargetCompletion
integer (int64) | null
When course assignment is expected to be completed by the student (in Unix epoch time)
Example1449496800
Start
integer (int64) | null
When the course assignment was started (if ever) (in Unix epoch time)
Example1449496800
Complete
integer (int64) | null
When the course assignment was completed (if ever) (in Unix epoch time)
Was this article helpful?