Absorb Integration API (v2)
Download OpenAPI specification:Download
Lists all selected LMS Departments that are available to the current, authenticated administrator.
Authorizations:
query Parameters
| departmentName | string Query parameter for filtering Departments by the department name. |
| externalId | string Query parameter for filtering Departments by the specified external ID. |
| 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:
|
| _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 |
| _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 (DepartmentResource) The department list. |
Response samples
- 200
- 422
{- "totalItems": 0,
- "returnedItems": 0,
- "limit": 0,
- "offset": 0,
- "departments": [
- {
- "id": "string",
- "name": "string",
- "useDepartmentContactDetails": true,
- "companyName": "string",
- "phoneNumber": "string",
- "emailAddress": "string",
- "externalId": "string",
- "parentId": "string",
- "currencyId": "string",
- "dateEdited": "2019-08-24T14:15:22Z",
- "dateAdded": "2019-08-24T14:15:22Z"
}
]
}Create or update department.
Authorizations:
header Parameters
| x-api-key | string |
| x-api-version | string 2 |
Request Body schema: application/json
The new department's data.
| id | string <guid> Department identifier. |
| name | string The full name of the department. |
| useDepartmentContactDetails | boolean If true, department contact details are used. |
| companyName | string The Company Name. |
| phoneNumber | string The Company PhoneNumber. |
| emailAddress | string The Company EmailAddress. |
| externalId | string The department unique identifier in the external system. |
| parentId | string <guid> The parent department unique identifier. |
| currencyId | string <guid> The currency unique identifier. |
Responses
Response Schema: application/json
| id | string <guid> The department Id. |
| name | string The department name. |
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "useDepartmentContactDetails": true,
- "companyName": "string",
- "phoneNumber": "string",
- "emailAddress": "string",
- "externalId": "string",
- "parentId": "string",
- "currencyId": "string"
}Response samples
- 201
- 409
- 422
{- "id": "string",
- "name": "string"
}Get Department.
Authorizations:
path Parameters
| id required | string <guid> The department ID. |
header Parameters
| x-api-key | string |
| x-api-version | string 2 |
Responses
Response Schema: application/json
| id | string <guid> Department identifier. |
| name | string The full name of the department. |
| useDepartmentContactDetails | boolean Can we use Department Contact Details |
| companyName | string The Company Name. |
| phoneNumber | string The Company PhoneNumber. |
| emailAddress | string The Company EmailAddress. |
| externalId | string The department unique identifier in the external system. |
| parentId | string <guid> The parent department unique identifier. |
| currencyId | string <guid> The currency unique identifier. |
| dateEdited | string <date-time> The department's last edited date. |
| dateAdded | string <date-time> The date the department was added. |
Response samples
- 200
- 404
{- "id": "string",
- "name": "string",
- "useDepartmentContactDetails": true,
- "companyName": "string",
- "phoneNumber": "string",
- "emailAddress": "string",
- "externalId": "string",
- "parentId": "string",
- "currencyId": "string",
- "dateEdited": "2019-08-24T14:15:22Z",
- "dateAdded": "2019-08-24T14:15:22Z"
}Create or update department.
Authorizations:
header Parameters
| x-api-key | string |
| x-api-version | string 2 |
Request Body schema: application/json
The new department's data.
| id | string <guid> Department identifier. |
| name | string The full name of the department. |
| useDepartmentContactDetails | boolean If true, department contact details are used. |
| companyName | string The Company Name. |
| phoneNumber | string The Company PhoneNumber. |
| emailAddress | string The Company EmailAddress. |
| externalId | string The department unique identifier in the external system. |
| parentId | string <guid> The parent department unique identifier. |
| currencyId | string <guid> The currency unique identifier. |
Responses
Response Schema: application/json
| id | string <guid> The department Id. |
| name | string The department name. |
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "useDepartmentContactDetails": true,
- "companyName": "string",
- "phoneNumber": "string",
- "emailAddress": "string",
- "externalId": "string",
- "parentId": "string",
- "currencyId": "string"
}Response samples
- 201
- 409
- 422
{- "id": "string",
- "name": "string"
}