Create User Assignment

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

id

string

required

Body

application/json

passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

external_reference

string | null

deprecated

The external reference associated with this assignment

Example:

"e3gd34-23tr21-er234-345er56"

learning_object_id

string | null

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

Example:

"e3gd34-23tr21-er234-345er56"

learning_object_external_reference

string | null

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

Example:

"learning-content-123"

progress

number | null

The progress associated with this assigment

Example:

"40"

created_at

string | null

The date the assignment was created

Example:

"2021-07-21T14:00:00.000Z"

due_date

string | null

The date the assignment is due to be completed

Example:

"2021-07-21T14:00:00.000Z"

status

object

The status of the assignment

Show child attributes

status.value

enum<string> | null

Available options:

pending,

in_progress,

completed

Example:

"in-progress"

status.source_value

Response

201

application/json

The assignment was created successfully.

statusCode

number

required

Example:

201

message

string

required

Example:

"Record created successfully."

timestamp

string

required

Example:

"2021-01-01T01:01:01.000Z"

data

object

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"