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

List User Assignments

cURL

curl --request GET \
  --url https://api.stackone.com/unified/lms/users/{id}/assignments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

200

{
  "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",
      "progress": "40",
      "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",
        "source_value": "<string>"
      },
      "learning_object_type": {
        "value": "content",
        "source_value": "<string>"
      },
      "user_id": "c28xyrc55866bvuv",
      "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "certificate_url": "https://example.com/certificate/12345",
      "result": {
        "value": "Pass",
        "source_value": "<string>"
      },
      "completed_at": "2021-07-21T14:00:00.000Z",
      "course_id": "16873-ENG-1",
      "remote_course_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

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

Query Parameters

raw · boolean | null

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

proxy · object

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

fields · string | null

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

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"

filter · object

LMS Assignment Filter

Show child attributes

filter. updated_after · string<date-time> | null

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

Example:

"2020-01-01T00:00:00.000Z"

filter. status · enum<string> | null

Filter to select assignment by status

Available options: pending, in_progress, completed, unmapped_value,

page · string | null

The page number of the results to fetch

page_size · string | null

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

next · string | null

The unified cursor

updated_after · string<date-time> | null

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

Example:

"2020-01-01T00:00:00.000Z"

user_id · string | null

The user ID associated with this assignment

Example:

"c28xyrc55866bvuv"

remote_user_id · string | null

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

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

Response

200

application/json

The assignments related to the employee with the given identifier were retrieved.

data · object[] · required

Show child attributes

data. id · string | null

The ID associated with this assignment

Example:

"123456"

data. remote_id · string | null

Provider's unique identifier

Example:

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

data. unified_custom_fields · object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data. external_reference · string | null · deprecated

The external reference associated with this assignment

Example:

"e3gd34-23tr21-er234-345er56"

data. 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"

data. remote_learning_object_id · string | null

Provider's unique identifier of the learning object related to the assignment

Example:

"e3cb55bf-aa84-466e-a6c1-b8302b257a49"

data. 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"

data. progress · number | null

The progress associated with this assigment

Example:

"40"

data. updated_at · string<date-time> | null

The date the assignment was last updated

Example:

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

data. created_at · string<date-time> | null

The date the assignment was created

Example:

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

data. assigned_at · string<date-time> | null

The date the assignment was assigned

Example:

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

data. due_date · string<date-time> | null

The date the assignment is due to be completed

Example:

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

data. status · object

The status of the assignment

Show child attributes

data.status. value · enum<string> | null

The StackOne unified assignment status.

Available options: pending, in_progress, completed, unmapped_value,

Example:

"in_progress"

data.status. source_value

The original status value from the provider before normalization.

data. learning_object_type · object

The learning object type of the assignment

Show child attributes

data.learning_object_type. value · enum<string> | null

The StackOne unified learning object type.

Available options: content, course, collection, unmapped_value,

data.learning_object_type. source_value

The original learning object type from the provider before normalization.

data. user_id · string | null

The user ID associated with this assignment

Example:

"c28xyrc55866bvuv"

data. remote_user_id · string | null

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

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data. certificate_url · string | null

The certification URL associated with this assignment

Example:

"https://example.com/certificate/12345"

data. result · object

The result of the assignment

Show child attributes

data.result. value · enum<string> | null

The StackOne unified result status.

Available options: Pass, Fail, unmapped_value,

data.result. source_value

The original result status from the provider before normalization.

data. completed_at · string<date-time> | null

The date the content was completed

Example:

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

data. course_id · string | null · deprecated

The course ID associated with this assignment

Example:

"16873-ENG-1"

data. remote_course_id · string | null · deprecated

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

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

next · string | null

raw · object[] | null

Show child attributes

raw. method · string · required

raw. url · string · required

raw. body · object

raw. response