• Session Schedules
  • getList session schedules.
  • getGet session schedule.

API docs by Redocly

Absorb Integration API (v1)

Download OpenAPI specification:Download

Session Schedules

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 1

Responses

Response Schema: application/json

Array

id	string <guid> Filterable The unique session schedule identifier.
sessionId	string <guid> Filterable The session schedule's session ID.
venueId	string <guid> Filterable The session schedule's venue ID.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 Sortable Filterable 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 Sortable Filterable The session schedule's venue name.
dateStart	string <date-time> Sortable Filterable The session schedule's starting date.
dateEnd	string <date-time> Sortable Filterable The session schedule's end date.
timeZoneId	string Sortable Filterable The session schedule's time zone ID.
meetingId	string Sortable Filterable The session schedule's meeting ID.
meetingUsername	string Sortable Filterable The session schedule's meeting username.
meetingPassword	string Sortable Filterable The session schedule's meeting password.

US

https://rest.myabsorb.com/session-schedules

CA

https://rest.myabsorb.ca/session-schedules

EU

https://rest.myabsorb.eu/session-schedules

AU

https://rest.myabsorb.com.au/session-schedules

Response samples

• 200
• 422

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"

  }

]

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 1

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.

US

https://rest.myabsorb.com/session-schedules/{id}

CA

https://rest.myabsorb.ca/session-schedules/{id}

EU

https://rest.myabsorb.eu/session-schedules/{id}

AU

https://rest.myabsorb.com.au/session-schedules/{id}

Response samples

• 200
• 404

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"

}