Sign in

v1

latestOpenAPI 3.1.02026-07-122360148.3 KB
Users
Assignments

List User Assignments

Retrieve a list of assignment type learning records for a user.

These are the records linking a user to learning objects.

They can be pending, in progress, or completed.

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

Path parameters

idstring 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
Example:id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

updated_afterstring date-time nullable

Use a string with a date to only select results updated after that given date

status'pending' | 'in_progress' | 'completed' | 'unmapped_value' | 'null' nullable

Filter to select assignment by status

LMS Assignment Filter

{
  "updated_after": "2020-01-01T00:00:00.000Z"
}
pagestring nullable

The page number of the results to fetch

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

updated_afterstring date-time nullable
Example:2020-01-01T00:00:00.000Z

Use a string with a date to only select results updated after that given date

user_idstring nullable
Example:c28xyrc55866bvuv

The user ID associated with this assignment

remote_user_idstring nullable
Example:e3cb75bf-aa84-466e-a6c1-b8322b257a48

Provider's unique identifier of the user related to the assignment

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 assignments related to the employee with the given identifier were retrieved.

nextstring nullable

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"
    }
  ]
}