Absorb Integration API (v2)
Download OpenAPI specification:Download
List credit types available for enrollments.
Authorizations:
api_key
header Parameters
x-api-key | string |
x-api-version | string 2 |
Responses
Response Schema: application/json
Array
id | string <guid> The unique credit type identifier. |
name | string The credit type's name. |
isCustom | boolean True if this is a custom credit type, false if it is the default general type. |
dateAdded | string <date-time> The date when the credit type was added. |
dateEdited | string <date-time> The date when the credit type was last edited. |
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "name": "string",
- "isCustom": true,
- "dateAdded ": "2019-08-24T14:15:22Z",
- "dateEdited": "2019-08-24T14:15:22Z"
}
]
List credits from a specific user's course enrollment.
Authorizations:
api_key
path Parameters
userId required | string <guid> The user ID. |
enrollmentId required | string <guid> The enrollment ID. |
header Parameters
x-api-key | string |
x-api-version | string 2 |
Responses
Response Schema: application/json
Array
id | string <guid> The unique course enrollment credit identifier. |
credits | number <decimal> The number of awarded credits for the specified credit type. |
creditTypeId | string <guid> The credit type's ID. |
creditTypeName | string The credit type's name. |
enrollmentId | string <guid> The enrollment's ID. |
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": "string",
- "credits": 0,
- "creditTypeId": "string",
- "creditTypeName": "string",
- "enrollmentId": "string"
}
]