Absorb Integration API (v2)

Download OpenAPI specification:Download

Prerequisites

List prerequisites.

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 prerequisite identifier.
name	string The prerequisite's name.
requiredNumber	integer <int32> The number of courses/competencies needed to satisfy the prerequisite.
prerequisiteType	integer Enum: 0 1 2 The prerequisite's type. Possible Enum Values: `0 = Courses` `1 = Certificates` `2 = Competencies`
courseIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of course IDs, if any.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of competency definition IDs, if any.

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"requiredNumber": 0,
"prerequisiteType": 0,
"courseIds": ["string"
],
"competencyDefinitionIds": ["string"
]
}
]

Get prerequisite.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The prerequisite ID.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> The unique prerequisite identifier.
name	string The prerequisite's name.
requiredNumber	integer <int32> The number of courses/competencies needed to satisfy the prerequisite.
prerequisiteType	integer Enum: 0 1 2 The prerequisite's type. Possible Enum Values: `0 = Courses` `1 = Certificates` `2 = Competencies`
courseIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of course IDs, if any.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of competency definition IDs, if any.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"requiredNumber": 0,
"prerequisiteType": 0,
"courseIds": ["string"
],
"competencyDefinitionIds": ["string"
]
}

List prerequisites for a specific course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The course ID.

header Parameters

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

Responses

Response Schema: application/json

Array

id	string <guid> The unique prerequisite identifier.
name	string The prerequisite's name.
requiredNumber	integer <int32> The number of courses/competencies needed to satisfy the prerequisite.
prerequisiteType	integer Enum: 0 1 2 The prerequisite's type. Possible Enum Values: `0 = Courses` `1 = Certificates` `2 = Competencies`
courseIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of course IDs, if any.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The prerequisite's list of competency definition IDs, if any.

Response samples

200
404

Content type

application/json

[{"id": "string",
"name": "string",
"requiredNumber": 0,
"prerequisiteType": 0,
"courseIds": ["string"
],
"competencyDefinitionIds": ["string"
]
}
]