API docs by Redocly

Progress API (1.0.0)

Download OpenAPI specification:Download

Progress

Fetch multiple progresses

header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
X-Auth-Token
required
string
Example: d417473a-dc63-11ec-9d64-0242ac120002

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create a progress

header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Request Body schema: application/json
required
itemId
required
string
itemType
required
string
Enum: "Course" "Lesson" "LessonSteps" "Video" "VideoSeries" "Qualification"
status
string
Enum: "started" "completed"
object

Responses

Request samples

Content type
application/json
{
  • "itemId": "1234",
  • "itemType": "Course",
  • "status": "started",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a progress

Update progress by id

path Parameters
id
required
string
Example: e4cc5e1a-1240-11eb-9573-0242ac140005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Request Body schema: application/json
required
status
string
Enum: "started" "completed"
object

Responses

Request samples

Content type
application/json
{
  • "status": "completed",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}