Resource

{
    "data": {
        "assigned_at": "YYYY-MM-DD hh:mm:ss",
        "attempts": "number",
        "completed_at": "YYYY-MM-DD hh:mm:ss",
        "course_id": "integer",
        "deadline": "YYYY-MM-DD",
        "progress": "number",
        "renewal_at": "YYYY-MM-DD hh:mm:ss",
        "required": "number",
        "score": "string",
        "started_at": "YYYY-MM-DD hh:mm:ss",
        "status": "string",
        "time_spent": "number",
        "user_id": "integer"
    },
    "extended_message": "string",
    "message": "string",
    "status": "string",
    "status_code": "integer"
}

Properties

Name Example Description
data
data.assigned_at "2019-02-08 12:13:35"

When the user was assigned the course

data.attempts 15

How many attempts it has taken the user to finish so far

data.completed_at "2019-02-08 12:13:35"

When the user completed the course

data.course_id 2

eloomis internal id for the course

data.deadline "2019-02-30"

When the user needs to have completed the course

data.progress "33.33"

How far the user has progressed in the course in percent

data.renewal_at "2019-02-08 12:13:35"

Optional property (may be missed in response) which depends on extended_mode param in request. Renewal date if any of participant assigment

data.required 1

A flag to indicate if the course is required for the user or not

Possible values are:

  • %!s(float64=0)
  • %!s(float64=1)
data.score "0.00"

A stringified number that tells the users score

data.started_at "2019-02-08 12:13:35"

When the user started taking the course

data.status "started"

Optional property (may be missed in response) which depends on extended_mode param in request. Processing status of participant assigment

Possible values are:

  • completed
  • not_started
  • started
data.time_spent 15

Seconds spent completing the course

data.user_id 5

eloomis internal id for the user

extended_message

Text to help with debugging

message

Text to help with debugging

status "OK"

HTTP Status text

status_code 200

HTTP Status code