v1

latestOpenAPI 3.1.02026-07-122360148.3 KB

Users

Completions

Create User Completion

Create a completed learning record for a user.

This is the record of a user completing a learning object.

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

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

completed_atstring date-time nullable

The date the content was completed

learning_object_idstring nullable

The id of the learning object associated with this completion. This is not required unless specified in an integration.

time_spentstring string nullable

ISO 8601 duration format representing the time spent on completing the learning object

content_external_referencestring nullable

The external reference associated with this content

content_idstring nullable

The content ID associated with this completion

learning_object_external_referencestring required

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

Example request

{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "completed_at": "2021-07-21T14:00:00.000Z",
  "learning_object_id": "e3gd34-23tr21-er234-345er56",
  "time_spent": "PT1H30M45S",
  "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
  "content_id": "16873-ENG-VIDEO-1",
  "score": {
    "percentage": 87.5,
    "raw_value": "87 / 100"
  },
  "learning_object_external_reference": "learning-content-123"
}

Response

The completion 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"
  }
}