Absorb Integration API (v1)

Download OpenAPI specification:Download

Certificates

Get certificate.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The ID of the certificate.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> Certificate identifier.
enrollmentId	string <guid> Enrollment identifier.
fullName	string The full name of the user.
courseName	string The name of the course.
acquiredDate	string <date-time> The acquired date of the certificate.
expiryDate	string <date-time> The expiry date of the certificate.
notes	string The notes on the certificate.
dateAdded	string <date-time> The date the certificate was added.
dateEdited	string <date-time> The date the certificate was last edited.

Response samples

200
404

Content type

application/json

{"id": "string",
"enrollmentId": "string",
"fullName": "string",
"courseName": "string",
"acquiredDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"notes": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}

Lists certificates for the user.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The user's ID.

query Parameters

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 1

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

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"certificates": [{"id": "string",
"enrollmentId": "string",
"fullName": "string",
"courseName": "string",
"acquiredDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"notes": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}
]
}

Get certificate for the user.

Authorizations:

api_key

path Parameters

id required	string <guid> The ID of the certificate.
userId required	string <guid> The user's unique identifier.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> Certificate identifier.
enrollmentId	string <guid> Enrollment identifier.
fullName	string The full name of the user.
courseName	string The name of the course.
acquiredDate	string <date-time> The acquired date of the certificate.
expiryDate	string <date-time> The expiry date of the certificate.
notes	string The notes on the certificate.
dateAdded	string <date-time> The date the certificate was added.
dateEdited	string <date-time> The date the certificate was last edited.

Response samples

200
404

Content type

application/json

{"id": "string",
"enrollmentId": "string",
"fullName": "string",
"courseName": "string",
"acquiredDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"notes": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}

Lists certificates for a course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The ID of the course.

query Parameters

includeExpired	boolean True if expired certificates are requested, false otherwise.
acquiredDate	string <date-time> Filters the list of certificates by the acquired date (yyyy-mm-dd) if specified.
expiryDate	string <date-time> Filters the list of certificates by the expiry date (yyyy-mm-dd) if specified.
_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` Certificate identifier.
enrollmentId	string <guid> `Filterable` Enrollment identifier.
fullName	string `Sortable` `Filterable` The full name of the user.
courseName	string `Default Sort` `Sortable` `Filterable` The name of the course.
acquiredDate	string <date-time> `Sortable` `Filterable` The acquired date of the certificate.
expiryDate	string <date-time> `Sortable` `Filterable` The expiry date of the certificate.
notes	string `Filterable` The notes on the certificate.
dateAdded	string <date-time> `Sortable` `Filterable` The date the certificate was added.
dateEdited	string <date-time> `Sortable` `Filterable` The date the certificate was last edited.

Response samples

200
404
422

Content type

application/json

[{"id": "string",
"enrollmentId": "string",
"fullName": "string",
"courseName": "string",
"acquiredDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"notes": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}
]

Get certificate for a course.

Authorizations:

api_key

path Parameters

certificateId required	string <guid> The ID of the certificate.
courseId required	string <guid> The course's unique identifier.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> Certificate identifier.
enrollmentId	string <guid> Enrollment identifier.
fullName	string The full name of the user.
courseName	string The name of the course.
acquiredDate	string <date-time> The acquired date of the certificate.
expiryDate	string <date-time> The expiry date of the certificate.
notes	string The notes on the certificate.
dateAdded	string <date-time> The date the certificate was added.
dateEdited	string <date-time> The date the certificate was last edited.

Response samples

200
404

Content type

application/json

{"id": "string",
"enrollmentId": "string",
"fullName": "string",
"courseName": "string",
"acquiredDate": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z",
"notes": "string",
"dateAdded": "2019-08-24T14:15:22Z",
"dateEdited": "2019-08-24T14:15:22Z"
}