Retrieve course assignment information by external id

  • Updated on Jul 16, 2024
  • 1 minute(s) read
Prev Next
Get
/GetCourseAssignmentByExternalId/{id}

Allows you to get information about a course assignment by providing a unique identifier from your external system.

Security
API Key
Header parameter nameapi_key
Path parameters
id
stringRequired

The external ID of the course assignment to retrieve

Responses
200

OK Response

Expand All
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)