Skip to main content
Version: v2

Absorb Integration API (v2)

Download OpenAPI specification:Download

Lessons

Get lesson.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The lesson ID.

header Parameters
x-api-key
string
x-api-version
string

2

Responses

Response Schema: application/json
id
string <guid>

The unique lesson identifier.

chapterId
string <guid>

The lesson's chapter ID.

name
string

The lesson's name.

description
string

The lesson's description.

notes
string

The lesson's notes.

type
string

The lesson's type.

width
integer <int32>

The lesson's content width.

height
integer <int32>

The lesson's content height.

url
string

The lesson's URL.

usePopup
boolean

True if the lesson is displayed in a popup window, false otherwise.

passingScore
number <decimal>

The lesson's passing score, as a percentage.

weight
number <decimal>

The lesson's weight.

refId
string

The lesson's reference ID

order
integer <int32>

The lesson's order within a chapter.

Response samples

Content type
application/json
{
  • "id": "string",
  • "chapterId": "string",
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "type": "string",
  • "width": 0,
  • "height": 0,
  • "url": "string",
  • "usePopup": true,
  • "passingScore": 0,
  • "weight": 0,
  • "refId": "string",
  • "order": 0
}

List lessons from a specific online course.

Authorizations:
api_key
path Parameters
courseId
required
string <guid>

The course ID.

header Parameters
x-api-key
string
x-api-version
string

2

Responses

Response Schema: application/json
Array
id
string <guid>

The unique lesson identifier.

chapterId
string <guid>

The lesson's chapter ID.

name
string

The lesson's name.

description
string

The lesson's description.

notes
string

The lesson's notes.

type
string

The lesson's type.

width
integer <int32>

The lesson's content width.

height
integer <int32>

The lesson's content height.

url
string

The lesson's URL.

usePopup
boolean

True if the lesson is displayed in a popup window, false otherwise.

passingScore
number <decimal>

The lesson's passing score, as a percentage.

weight
number <decimal>

The lesson's weight.

refId
string

The lesson's reference ID

order
integer <int32>

The lesson's order within a chapter.

Response samples

Content type
application/json
[
  • {
    }
]

Get lesson from a specific course.

Authorizations:
api_key
path Parameters
courseId
required
string <guid>

The course ID.

lessonId
required
string <guid>

The lesson ID.

header Parameters
x-api-key
string
x-api-version
string

2

Responses

Response Schema: application/json
id
string <guid>

The unique lesson identifier.

chapterId
string <guid>

The lesson's chapter ID.

name
string

The lesson's name.

description
string

The lesson's description.

notes
string

The lesson's notes.

type
string

The lesson's type.

width
integer <int32>

The lesson's content width.

height
integer <int32>

The lesson's content height.

url
string

The lesson's URL.

usePopup
boolean

True if the lesson is displayed in a popup window, false otherwise.

passingScore
number <decimal>

The lesson's passing score, as a percentage.

weight
number <decimal>

The lesson's weight.

refId
string

The lesson's reference ID

order
integer <int32>

The lesson's order within a chapter.

Response samples

Content type
application/json
{
  • "id": "string",
  • "chapterId": "string",
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "type": "string",
  • "width": 0,
  • "height": 0,
  • "url": "string",
  • "usePopup": true,
  • "passingScore": 0,
  • "weight": 0,
  • "refId": "string",
  • "order": 0
}

Get lesson from a specific course and chapter.

Authorizations:
api_key
path Parameters
courseId
required
string <guid>

The course ID.

chapterId
required
string <guid>

The chapter ID.

lessonId
required
string <guid>

The lesson ID.

header Parameters
x-api-key
string
x-api-version
string

2

Responses

Response Schema: application/json
id
string <guid>

The unique lesson identifier.

chapterId
string <guid>

The lesson's chapter ID.

name
string

The lesson's name.

description
string

The lesson's description.

notes
string

The lesson's notes.

type
string

The lesson's type.

width
integer <int32>

The lesson's content width.

height
integer <int32>

The lesson's content height.

url
string

The lesson's URL.

usePopup
boolean

True if the lesson is displayed in a popup window, false otherwise.

passingScore
number <decimal>

The lesson's passing score, as a percentage.

weight
number <decimal>

The lesson's weight.

refId
string

The lesson's reference ID

order
integer <int32>

The lesson's order within a chapter.

Response samples

Content type
application/json
{
  • "id": "string",
  • "chapterId": "string",
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "type": "string",
  • "width": 0,
  • "height": 0,
  • "url": "string",
  • "usePopup": true,
  • "passingScore": 0,
  • "weight": 0,
  • "refId": "string",
  • "order": 0
}

List lessons.

Authorizations:
api_key
query Parameters
_filter
string

One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered.

Supports most of the OData filter syntax.

Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * ()

Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName)

Examples:

  • _filter=firstname eq 'Jeffrey'
  • _filter=id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'
  • _filter=startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'
_sort
string

Optional list of comma-separated fields to sort the collection by.

The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned.

To sort in a descending manner, prefix the field name with -. For example, _sort=name,-date, sorts the collection of items by name (ascending) and then by date (descending).

_limit
string

The maximum number of items to return in the current page of the collection.

_offset
string

The number of pages to offset into the collection.

header Parameters
x-api-key
string
x-api-version
string

2

Responses

Response Schema: application/json
totalItems
integer <int32>

The total number of items in the unbounded collection

returnedItems
integer <int32>

The number of items in the bound collection being returned

limit
integer <int32>

The current page size for the collection

offset
integer <int32>

The current offset for the collection

Array of objects (LessonResource)

Response samples

Content type
application/json
{
  • "totalItems": 0,
  • "returnedItems": 0,
  • "limit": 0,
  • "offset": 0,
  • "lessons": [
    ]
}