Version: v1

Absorb Integration API (v1)

Download OpenAPI specification:Download

Venues

List venues.

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 venue identifier.
name	string `Default Sort` `Sortable` `Filterable` The venue's name.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 `Sortable` `Filterable` The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string `Sortable` `Filterable` The venue's virtual meeting space.
phoneNumber	string `Sortable` `Filterable` The venue's phone number.
address	string `Sortable` `Filterable` The venue's street address.
city	string `Sortable` `Filterable` The venue's city.
province	string `Sortable` `Filterable` The venue's province.
postalCode	string `Sortable` `Filterable` The venue's postal code/zip.
country	string `Sortable` `Filterable` The venue's country.
maxClassSize	integer <int32> `Sortable` `Filterable` The venue's maximum class size.
details	string `Filterable` The venue's details.
meetingId	string `Filterable` The venue's meeting ID.
username	string `Sortable` `Filterable` The venue's username.
password	string `Sortable` `Filterable` The venue's password.

Response samples

Content type

application/json

[{"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"
}
]

Create venue.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The request to create a venue.

id	string <guid> The unique identifier to use for the venue. If not supplied one will be created.
name required	string [ 0 .. 255 ] characters The venue's name.
venueType required	integer Enum: 0 1 2 3 4 5 6 7 8 The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string [ 0 .. 255 ] characters The venue's virtual meeting space.
phoneNumber	string [ 0 .. 255 ] characters The venue's phone number.
address	string [ 0 .. 4000 ] characters The venue's street address.
city	string [ 0 .. 255 ] characters The venue's city.
province	string The venue's province.
postalCode	string [ 0 .. 255 ] characters The venue's postal code/zip.
country	string The venue's country.
maxClassSize	integer <int32> [ 0 .. 2147483647 ] The venue's maximum class size.
details	string [ 0 .. 2147483647 ] characters The venue's details.
meetingId	string [ 0 .. 255 ] characters The venue's meeting ID.
username	string [ 0 .. 255 ] characters The venue's username.
password	string [ 0 .. 255 ] characters The venue's password.

Responses

Response Schema: application/json

id	string <guid> The unique venue identifier.
name	string The venue's name.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string The venue's virtual meeting space.
phoneNumber	string The venue's phone number.
address	string The venue's street address.
city	string The venue's city.
province	string The venue's province.
postalCode	string The venue's postal code/zip.
country	string The venue's country.
maxClassSize	integer <int32> The venue's maximum class size.
details	string The venue's details.
meetingId	string The venue's meeting ID.
username	string The venue's username.
password	string The venue's password.

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"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"
}

Get venue.

Authorizations:

api_key

path Parameters

required

string <guid>

The venue ID.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id	string <guid> The unique venue identifier.
name	string The venue's name.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string The venue's virtual meeting space.
phoneNumber	string The venue's phone number.
address	string The venue's street address.
city	string The venue's city.
province	string The venue's province.
postalCode	string The venue's postal code/zip.
country	string The venue's country.
maxClassSize	integer <int32> The venue's maximum class size.
details	string The venue's details.
meetingId	string The venue's meeting ID.
username	string The venue's username.
password	string The venue's password.

Response samples

Content type

application/json

{"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"
}

Update venue.

Authorizations:

api_key

path Parameters

required

string <guid>

The unique venue identifier.

header Parameters

x-api-key	string
x-api-version	string 1

Request Body schema: application/json

The model of the venue data.

name	string [ 0 .. 255 ] characters The venue's name.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string [ 0 .. 255 ] characters The venue's virtual meeting space.
phoneNumber	string [ 0 .. 255 ] characters The venue's phone number.
address	string [ 0 .. 4000 ] characters The venue's street address.
city	string [ 0 .. 255 ] characters The venue's city.
province	string The venue's province.
postalCode	string [ 0 .. 255 ] characters The venue's postal code/zip.
country	string The venue's country.
maxClassSize	integer <int32> [ 0 .. 2147483647 ] The venue's maximum class size.
details	string [ 0 .. 2147483647 ] characters The venue's details.
meetingId	string [ 0 .. 255 ] characters The venue's meeting ID.
username	string [ 0 .. 255 ] characters The venue's username.
password	string [ 0 .. 255 ] characters The venue's password.

Responses

Response Schema: application/json

id	string <guid> The unique venue identifier.
name	string The venue's name.
venueType	integer Enum: 0 1 2 3 4 5 6 7 8 The venue's type. Possible Enum Values: `0 = Classroom` `1 = ConnectPro` `2 = WebEx` `3 = GoToMeeting` `4 = Url` `5 = ZoomMeeting` `6 = ZoomWebinar` `7 = TeamsMeeting` `8 = WebexMeeting`
url	string The venue's virtual meeting space.
phoneNumber	string The venue's phone number.
address	string The venue's street address.
city	string The venue's city.
province	string The venue's province.
postalCode	string The venue's postal code/zip.
country	string The venue's country.
maxClassSize	integer <int32> The venue's maximum class size.
details	string The venue's details.
meetingId	string The venue's meeting ID.
username	string The venue's username.
password	string The venue's password.

Request samples

Payload

Content type

application/json

{"name": "string",
"venueType": 0,
"url": "string",
"phoneNumber": "string",
"address": "string",
"city": "string",
"province": "string",
"postalCode": "string",
"country": "string",
"maxClassSize": 2147483647,
"details": "string",
"meetingId": "string",
"username": "string",
"password": "string"
}

Response samples

Content type

application/json

{"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"
}