Absorb Integration API (v2)

Download OpenAPI specification:Download

Submissions

List submissions.

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 (SubmissionResource) The paged collection of submissions.

Response samples

200
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"submissions": [{"id": "string",
"userId": "string",
"templateId": "string",
"title": "string",
"completionDate": "2019-08-24T14:15:22Z",
"cost": "string",
"credits": 0,
"description": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"score": 0,
"startDate": "2019-08-24T14:15:22Z",
"totalTimeSpent": 0.1,
"vendor": "string",
"vendorAddress": "string",
"grade": "string",
"status": 0
}
]
}

Create a new submission.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request to create a new submission.

title required	string [ 1 .. 255 ] characters The submission title.
userId required	string <guid> non-empty The user ID.
templateId required	string <guid> non-empty The template ID this submission is based on.
completionDate required	string <date-time> non-empty The date the course was completed.
status	integer Enum: 0 1 2 The status of the submission. Possible Enum Values: `0 = PendingApproval` `1 = Approved` `2 = Declined`
cost	string <= 255 characters The cost of the course.
credits	number <decimal> [ 0 .. 1000000 ] The credits earned for completing this course.
description	string <= 10000 characters The submission description.
expiryDate	string <date-time> The expiry date of the course.
startDate	string <date-time> The start date of the course.
score	number <decimal> [ 0 .. 100 ] The score earned (in percentage) for completing this course.
grade	string <= 255 characters The grade received for completing the course.
totalTimeSpent	number <double> [ 0 .. 1000000 ] The total time spent taking this course in hours.
vendor	string <= 255 characters The vendor who provided the course.
vendorAddress	string <= 255 characters The address of the vendor.

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"userId": "string",
"templateId": "string",
"completionDate": "2019-08-24T14:15:22Z",
"status": 0,
"cost": "string",
"credits": 1000000,
"description": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"score": 100,
"grade": "string",
"totalTimeSpent": 1000000,
"vendor": "string",
"vendorAddress": "string"
}

Response samples

404
422

Content type

application/json

{"validations": ["string"
],
"code": 0,
"message": "string",
"term": "string",
"_meta": {"property1": "string",
"property2": "string"
}
}

Get submission by ID.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The submission ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The ID of the submission.
userId	string <guid> The ID of the user the submission is for.
templateId	string <guid> The ID of the template used for this submission.
title	string The title of the submission.
completionDate	string <date-time> The date/time the submission was completed.
cost	string The cost of the course.
credits	number <decimal> The credits earned for completing this course.
description	string The submission description.
expiryDate	string <date-time> The expiry date of the course.
score	number <decimal> The score earned (in percentage) for completing this course.
startDate	string <date-time> The start date of the course.
totalTimeSpent	number <double> The total time spent taking this course.
vendor	string The vendor who provided the course.
vendorAddress	string The address of the vendor.
grade	string The grade received for completing the course.
status	integer Enum: 0 1 2 The status of the submission. Possible Enum Values: `0 = PendingApproval` `1 = Approved` `2 = Declined`

Response samples

200
404

Content type

application/json

{"id": "string",
"userId": "string",
"templateId": "string",
"title": "string",
"completionDate": "2019-08-24T14:15:22Z",
"cost": "string",
"credits": 0,
"description": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"score": 0,
"startDate": "2019-08-24T14:15:22Z",
"totalTimeSpent": 0.1,
"vendor": "string",
"vendorAddress": "string",
"grade": "string",
"status": 0
}

Update an existing submission.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The ID of the submission.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The request body to update a submission.

title required	string [ 1 .. 255 ] characters The submission title.
completionDate required	string <date-time> non-empty The date the course was completed.
status	integer Enum: 0 1 2 The status of the submission. Possible Enum Values: `0 = PendingApproval` `1 = Approved` `2 = Declined`
cost	string <= 255 characters The cost of the course.
credits	number <decimal> [ 0 .. 1000000 ] The credits earned for completing this course.
description	string <= 10000 characters The submission description.
expiryDate	string <date-time> The expiry date of the course.
startDate	string <date-time> The start date of the course.
score	number <decimal> [ 0 .. 100 ] The score earned (in percentage) for completing this course.
grade	string <= 255 characters The grade received for completing the course.
totalTimeSpent	number <double> [ 0 .. 1000000 ] The total time spent taking this course in hours.
vendor	string <= 255 characters The vendor who provided the course.
vendorAddress	string <= 255 characters The address of the vendor.

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"completionDate": "2019-08-24T14:15:22Z",
"status": 0,
"cost": "string",
"credits": 1000000,
"description": "string",
"expiryDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"score": 100,
"grade": "string",
"totalTimeSpent": 1000000,
"vendor": "string",
"vendorAddress": "string"
}

Response samples

404
422

Content type

application/json

{"validations": ["string"
],
"code": 0,
"message": "string",
"term": "string",
"_meta": {"property1": "string",
"property2": "string"
}
}

Templates

List templates.

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 (TemplateResource) The paged collection of templates.

Response samples

200
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"templates": [{"id": "string",
"name": "string",
"isActive": true
}
]
}

Get template by ID.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The template ID.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The ID of the template.
name	string The name of the template.
isActive	boolean True if the template is currently active; false otherwise

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"isActive": true
}