• Sessions
  • getList sessions.
  • getGet session.
  • getList sessions from a specific ILC.
  • getGet session from a specific ILC.
• Session Details
  • postList available session details from specific ILCs.
  • getList sessions from a specific user's ILC enrollments.

API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Sessions

List sessions.

Lists available sessions from all ILCs.

Authorizations:

api_key

query Parameters

externalId	string (Deprecated) The specified external ID to filter by.
limit	string (Deprecated) The maximum number of items to return in the current page of the collection.
offset	string (Deprecated) The number of pages to offset into the collection.
_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 (SessionResource)

US

https://rest.myabsorb.com/sessions

CA

https://rest.myabsorb.ca/sessions

EU

https://rest.myabsorb.eu/sessions

AU

https://rest.myabsorb.com.au/sessions

Response samples

• 200
• 422

Content type

application/json

{

• "totalItems": 0,
• "returnedItems": 0,
• "limit": 0,
• "offset": 0,
• "sessions": [

  • {

    • "id": "string",
    • "name": "string",
    • "description": "string",
    • "notes": "string",
    • "instructorIds": [

      • "string"

      ],
    • "approvalType": 0,
    • "approvalIds": [

      • "string"

      ],
    • "attendanceReminder": 0,
    • "enrollmentEndDate": "2019-08-24T14:15:22Z",
    • "enrollmentStartDate": "2019-08-24T14:15:22Z",
    • "dateEdited": "2019-08-24T14:15:22Z",
    • "dateAdded": "2019-08-24T14:15:22Z",
    • "minimumClassSize": 0,
    • "maximumClassSize": 0,
    • "isWaitlistEnabled": true,
    • "allowSelfEnrollment": true,
    • "sessionScheduleIds": [

      • "string"

      ],
    • "externalId": "string"

    }

  ]

}

Get session.

Authorizations:

api_key

path Parameters

id required

string <guid> The session ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The session ID.
name	string The session name.
description	string The session description.
notes	string The session notes.
instructorIds	Array of strings <guid> [ items <guid > ] The list of instructor IDs.
approvalType	integer Enum: 0 1 2 3 4 5 The session approval type. Possible Enum Values: 0 = None 1 = Instructor 2 = Administrator 3 = CourseEditor 4 = Supervisor 5 = Other
approvalIds	Array of strings <guid> [ items <guid > ] The explicit list of user IDs permitted to approve enrollments into this session.
attendanceReminder	integer <int32> The session attendance reminder.
enrollmentEndDate	string <date-time> The session enrollment end date.
enrollmentStartDate	string <date-time> The session enrollment start date.
dateEdited	string <date-time> The date the session was edited.
dateAdded	string <date-time> The date the session was added.
minimumClassSize	integer <int32> The session's minimum class size.
maximumClassSize	integer <int32> The session's maximum class size.
isWaitlistEnabled	boolean True if the session's waitlist is enabled, false otherwise.
allowSelfEnrollment	boolean True if the session allows self enrollment, false otherwise.
sessionScheduleIds	Array of strings <guid> [ items <guid > ] The list of session schedule IDs.
externalId	string The session external ID.

US

https://rest.myabsorb.com/sessions/{id}

CA

https://rest.myabsorb.ca/sessions/{id}

EU

https://rest.myabsorb.eu/sessions/{id}

AU

https://rest.myabsorb.com.au/sessions/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "notes": "string",
• "instructorIds": [

  • "string"

  ],
• "approvalType": 0,
• "approvalIds": [

  • "string"

  ],
• "attendanceReminder": 0,
• "enrollmentEndDate": "2019-08-24T14:15:22Z",
• "enrollmentStartDate": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z",
• "minimumClassSize": 0,
• "maximumClassSize": 0,
• "isWaitlistEnabled": true,
• "allowSelfEnrollment": true,
• "sessionScheduleIds": [

  • "string"

  ],
• "externalId": "string"

}

List sessions from a specific ILC.

Authorizations:

api_key

path Parameters

courseId required

string <guid> The instructor led course ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The session ID.
name	string The session name.
description	string The session description.
notes	string The session notes.
instructorIds	Array of strings <guid> [ items <guid > ] The list of instructor IDs.
approvalType	integer Enum: 0 1 2 3 4 5 The session approval type. Possible Enum Values: 0 = None 1 = Instructor 2 = Administrator 3 = CourseEditor 4 = Supervisor 5 = Other
approvalIds	Array of strings <guid> [ items <guid > ] The explicit list of user IDs permitted to approve enrollments into this session.
attendanceReminder	integer <int32> The session attendance reminder.
enrollmentEndDate	string <date-time> The session enrollment end date.
enrollmentStartDate	string <date-time> The session enrollment start date.
dateEdited	string <date-time> The date the session was edited.
dateAdded	string <date-time> The date the session was added.
minimumClassSize	integer <int32> The session's minimum class size.
maximumClassSize	integer <int32> The session's maximum class size.
isWaitlistEnabled	boolean True if the session's waitlist is enabled, false otherwise.
allowSelfEnrollment	boolean True if the session allows self enrollment, false otherwise.
sessionScheduleIds	Array of strings <guid> [ items <guid > ] The list of session schedule IDs.
externalId	string The session external ID.

US

https://rest.myabsorb.com/courses/{courseId}/sessions

CA

https://rest.myabsorb.ca/courses/{courseId}/sessions

EU

https://rest.myabsorb.eu/courses/{courseId}/sessions

AU

https://rest.myabsorb.com.au/courses/{courseId}/sessions

Response samples

• 200
• 404

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "instructorIds": [

    • "string"

    ],
  • "approvalType": 0,
  • "approvalIds": [

    • "string"

    ],
  • "attendanceReminder": 0,
  • "enrollmentEndDate": "2019-08-24T14:15:22Z",
  • "enrollmentStartDate": "2019-08-24T14:15:22Z",
  • "dateEdited": "2019-08-24T14:15:22Z",
  • "dateAdded": "2019-08-24T14:15:22Z",
  • "minimumClassSize": 0,
  • "maximumClassSize": 0,
  • "isWaitlistEnabled": true,
  • "allowSelfEnrollment": true,
  • "sessionScheduleIds": [

    • "string"

    ],
  • "externalId": "string"

  }

]

Get session from a specific ILC.

Authorizations:

api_key

path Parameters

courseId required	string <guid> The instructor led course ID.
sessionId required	string <guid> The session ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The session ID.
name	string The session name.
description	string The session description.
notes	string The session notes.
instructorIds	Array of strings <guid> [ items <guid > ] The list of instructor IDs.
approvalType	integer Enum: 0 1 2 3 4 5 The session approval type. Possible Enum Values: 0 = None 1 = Instructor 2 = Administrator 3 = CourseEditor 4 = Supervisor 5 = Other
approvalIds	Array of strings <guid> [ items <guid > ] The explicit list of user IDs permitted to approve enrollments into this session.
attendanceReminder	integer <int32> The session attendance reminder.
enrollmentEndDate	string <date-time> The session enrollment end date.
enrollmentStartDate	string <date-time> The session enrollment start date.
dateEdited	string <date-time> The date the session was edited.
dateAdded	string <date-time> The date the session was added.
minimumClassSize	integer <int32> The session's minimum class size.
maximumClassSize	integer <int32> The session's maximum class size.
isWaitlistEnabled	boolean True if the session's waitlist is enabled, false otherwise.
allowSelfEnrollment	boolean True if the session allows self enrollment, false otherwise.
sessionScheduleIds	Array of strings <guid> [ items <guid > ] The list of session schedule IDs.
externalId	string The session external ID.

US

https://rest.myabsorb.com/courses/{courseId}/sessions/{sessionId}

CA

https://rest.myabsorb.ca/courses/{courseId}/sessions/{sessionId}

EU

https://rest.myabsorb.eu/courses/{courseId}/sessions/{sessionId}

AU

https://rest.myabsorb.com.au/courses/{courseId}/sessions/{sessionId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "notes": "string",
• "instructorIds": [

  • "string"

  ],
• "approvalType": 0,
• "approvalIds": [

  • "string"

  ],
• "attendanceReminder": 0,
• "enrollmentEndDate": "2019-08-24T14:15:22Z",
• "enrollmentStartDate": "2019-08-24T14:15:22Z",
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z",
• "minimumClassSize": 0,
• "maximumClassSize": 0,
• "isWaitlistEnabled": true,
• "allowSelfEnrollment": true,
• "sessionScheduleIds": [

  • "string"

  ],
• "externalId": "string"

}

Session Details

List available session details from specific ILCs.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

ids	Array of strings List of unique instructor led course identifiers.

Responses

Response Schema: application/json

Array

id	string <guid> The unique session identifier.
instructorLedCourseId	string <guid> The session's instructor led course ID.
name	string The session's name.
description	string The session's description.
approvalType	integer Enum: 0 1 2 3 4 5 The session's approval type. Possible Enum Values: 0 = None 1 = Instructor 2 = Administrator 3 = CourseEditor 4 = Supervisor 5 = Other
enrollmentStartDate	string <date-time> The session's optional UTC date that enrollments into the session are accepted.
enrollmentEndDate	string <date-time> The session's optional UTC date that enrollments into the session are no longer accepted.
enrollmentCount	integer <int32> The session's enrollment count.
isWaitlistEnabled	boolean True if the session has a waitlist enabled, false otherwise.
enrollmentLimit	integer <int32> The session's optional limit on the number of enrollments allowed.
enrollmentMinimum	integer <int32> The session's minimum number of enrollments required to be considered valid.
instructorIds	Array of strings <guid> [ items <guid > ] The session's list of instructor IDs.
externalId	string The session's external ID.
	Array of objects (ClassDetailResource) The session's list of classes.

US

https://rest.myabsorb.com/courses/session-details

CA

https://rest.myabsorb.ca/courses/session-details

EU

https://rest.myabsorb.eu/courses/session-details

AU

https://rest.myabsorb.com.au/courses/session-details

Request samples

• Payload

Content type

application/json

{

• "ids": [

  • "string"

  ]

}

Response samples

• 200
• 400
• 422

Content type

application/json

[

• {

  • "id": "string",
  • "instructorLedCourseId": "string",
  • "name": "string",
  • "description": "string",
  • "approvalType": 0,
  • "enrollmentStartDate": "2019-08-24T14:15:22Z",
  • "enrollmentEndDate": "2019-08-24T14:15:22Z",
  • "enrollmentCount": 0,
  • "isWaitlistEnabled": true,
  • "enrollmentLimit": 0,
  • "enrollmentMinimum": 0,
  • "instructorIds": [

    • "string"

    ],
  • "externalId": "string",
  • "classes": [

    • {

      • "id": "string",
      • "sessionId": "string",
      • "utcStartDate": "2019-08-24T14:15:22Z",
      • "utcEndDate": "2019-08-24T14:15:22Z",
      • "timeZone": "string",
      • "meetingUrl": "string",
      • "meetingDescription": "string",
      • "venue": {

        • "id": "string",
        • "name": "string",
        • "venueType": 0,
        • "url": "string",
        • "phoneNumber": "string",
        • "address": "string",
        • "city": "string",
        • "province": "string",
        • "postalCode": "string",
        • "country": "string",
        • "maxClassSize": 0,
        • "details": "string",
        • "meetingId": "string",
        • "username": "string",
        • "password": "string"

        }

      }

    ]

  }

]

List sessions from a specific user's ILC enrollments.

Additionally lists other available sessions that exist in the enrolled ILCs.

Authorizations:

api_key

path Parameters

userId required

string <guid> The user ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

id	string <guid> The unique session identifier.
instructorLedCourseId	string <guid> The session's instructor led course ID.
name	string The session's name.
description	string The session's description.
approvalType	integer Enum: 0 1 2 3 4 5 The session's approval type. Possible Enum Values: 0 = None 1 = Instructor 2 = Administrator 3 = CourseEditor 4 = Supervisor 5 = Other
enrollmentStartDate	string <date-time> The session's optional UTC date that enrollments into the session are accepted.
enrollmentEndDate	string <date-time> The session's optional UTC date that enrollments into the session are no longer accepted.
enrollmentCount	integer <int32> The session's enrollment count.
isWaitlistEnabled	boolean True if the session has a waitlist enabled, false otherwise.
enrollmentLimit	integer <int32> The session's optional limit on the number of enrollments allowed.
enrollmentMinimum	integer <int32> The session's minimum number of enrollments required to be considered valid.
instructorIds	Array of strings <guid> [ items <guid > ] The session's list of instructor IDs.
externalId	string The session's external ID.
	Array of objects (ClassDetailResource) The session's list of classes.
isEnrolledInSession	boolean True if user is enrolled in session, false otherwise.

US

https://rest.myabsorb.com/users/{userId}/session-details

CA

https://rest.myabsorb.ca/users/{userId}/session-details

EU

https://rest.myabsorb.eu/users/{userId}/session-details

AU

https://rest.myabsorb.com.au/users/{userId}/session-details

Response samples

• 200
• 404

Content type

application/json

[

• {

  • "id": "string",
  • "instructorLedCourseId": "string",
  • "name": "string",
  • "description": "string",
  • "approvalType": 0,
  • "enrollmentStartDate": "2019-08-24T14:15:22Z",
  • "enrollmentEndDate": "2019-08-24T14:15:22Z",
  • "enrollmentCount": 0,
  • "isWaitlistEnabled": true,
  • "enrollmentLimit": 0,
  • "enrollmentMinimum": 0,
  • "instructorIds": [

    • "string"

    ],
  • "externalId": "string",
  • "classes": [

    • {

      • "id": "string",
      • "sessionId": "string",
      • "utcStartDate": "2019-08-24T14:15:22Z",
      • "utcEndDate": "2019-08-24T14:15:22Z",
      • "timeZone": "string",
      • "meetingUrl": "string",
      • "meetingDescription": "string",
      • "venue": {

        • "id": "string",
        • "name": "string",
        • "venueType": 0,
        • "url": "string",
        • "phoneNumber": "string",
        • "address": "string",
        • "city": "string",
        • "province": "string",
        • "postalCode": "string",
        • "country": "string",
        • "maxClassSize": 0,
        • "details": "string",
        • "meetingId": "string",
        • "username": "string",
        • "password": "string"

        }

      }

    ],
  • "isEnrolledInSession": true

  }

]