Skip to main content
Version: v2
API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Session Schedules

Get session schedule.

Authorizations:
api_key
path Parameters
id
required
string <guid>

The ID of the session schedule.

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

2

Responses

Response Schema: application/json
id
string <guid>

The unique session schedule identifier.

sessionId
string <guid>

The session schedule's session ID.

venueId
string <guid>

The session schedule's venue ID.

venueType
integer
Enum: 0 1 2 3 4 5 6 7 8

The session schedule's venue type.

Possible Enum Values: 0 = Classroom 1 = ConnectPro 2 = WebEx 3 = GoToMeeting 4 = Url 5 = ZoomMeeting 6 = ZoomWebinar 7 = TeamsMeeting 8 = WebexMeeting

venueName
string

The session schedule's venue name.

dateStart
string <date-time>

The session schedule's starting date.

dateEnd
string <date-time>

The session schedule's end date.

timeZoneId
string

The session schedule's time zone ID.

meetingId
string

The session schedule's meeting ID.

meetingUsername
string

The session schedule's meeting username.

meetingPassword
string

The session schedule's meeting password.

Response samples

Content type
application/json
{
  • "id": "string",
  • "sessionId": "string",
  • "venueId": "string",
  • "venueType": 0,
  • "venueName": "string",
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "timeZoneId": "string",
  • "meetingId": "string",
  • "meetingUsername": "string",
  • "meetingPassword": "string"
}

List session schedules.

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 (SessionScheduleResource)

The paged collection of resources.

Response samples

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