Sign in

v1

latestOpenAPI 3.1.02026-07-122360148.3 KB
Users
Assignments

Get User Assignment

Retrieve an assignment type learning record for a user by its identifier.

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

It can be pending, in progress, or completed.

get/unified/lms/users/{id}/assignments/{subResourceId}

Path parameters

idstring required
subResourceIdstring required

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable

The comma separated list of fields to return in the response (if empty, all fields are returned)

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)

Response

The assignment with the given identifier was retrieved.

Example response

{
  "data": {
    "id": "123456",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "external_reference": "e3gd34-23tr21-er234-345er56",
    "learning_object_id": "e3gd34-23tr21-er234-345er56",
    "remote_learning_object_id": "e3cb55bf-aa84-466e-a6c1-b8302b257a49",
    "learning_object_external_reference": "learning-content-123",
    "updated_at": "2021-07-21T14:00:00.000Z",
    "created_at": "2021-07-21T14:00:00.000Z",
    "assigned_at": "2021-07-21T14:00:00.000Z",
    "due_date": "2021-07-21T14:00:00.000Z",
    "status": {
      "value": "in_progress"
    },
    "user_id": "c28xyrc55866bvuv",
    "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "certificate_url": "https://example.com/certificate/12345",
    "completed_at": "2021-07-21T14:00:00.000Z",
    "course_id": "16873-ENG-1",
    "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
  }
}