Sign in

v1

latestOpenAPI 3.1.02026-07-122360148.3 KB
Users
Assignments

Create User Assignment

Create an assignment type learning record for a user.

This is the record linking a user to a learning object.

It can be pending or in progress.

post/unified/lms/users/{id}/assignments

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

passthroughobject nullable

Value to pass through to the provider

external_referencestring nullable

The external reference associated with this assignment

learning_object_idstring nullable

The learning_object_id associated with this assignment. This is not required unless specified in an integration.

progressnumber nullable

The progress associated with this assigment

assigned_atstring date-time nullable

The date the assignment was assigned

due_datestring date-time nullable

The date the assignment is due to be completed

learning_object_external_referencestring required

The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.

Example request

{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "external_reference": "e3gd34-23tr21-er234-345er56",
  "learning_object_id": "e3gd34-23tr21-er234-345er56",
  "assigned_at": "2021-07-21T14:00:00.000Z",
  "due_date": "2021-07-21T14:00:00.000Z",
  "status": {
    "value": "in_progress"
  },
  "learning_object_external_reference": "learning-content-123"
}

Response

The assignment was created successfully.

statusCodenumber required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}