Absorb Integration API (v1)

Download OpenAPI specification:Download

Question Banks

List question banks.

Authorizations:

api_key

query Parameters

_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 (QuestionBankResource) The paged collection of resources.

Response samples

200
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"questionBanks": [{"id": "string",
"name": "string"
}
]
}

Create question bank.

Authorizations:

api_key

header Parameters

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

Request Body schema: application/json

The request to create a new question bank.

id	string <guid> The unique question bank identifier. If not supplied, one will be created.
name required	string [ 0 .. 255 ] characters The question bank name.

Responses

Response Schema: application/json

id	string <guid> The unique question bank identifier.
name	string The question bank name.

Request samples

Payload

Content type

application/json

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

Response samples

201
403
409
422

Content type

application/json

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

Get question bank.

Authorizations:

api_key

path Parameters

questionBankId

required

string <guid>

The unique question bank identifier.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> The unique question bank identifier.
name	string The question bank name.

Response samples

200
404
422

Content type

application/json

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

Update question bank.

Authorizations:

api_key

path Parameters

questionBankId

required

string <guid>

The unique question bank identifier.

header Parameters

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

Request Body schema: application/json

The model for the question bank data.

name

required

string [ 0 .. 255 ] characters

The question bank name.

Responses

Response Schema: application/json

id	string <guid> The unique question bank identifier.
name	string The question bank name.

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
403
404
422

Content type

application/json

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

Question Bank Questions

Get question bank question.

Authorizations:

api_key

path Parameters

questionBankId required	string <guid> The unique question bank identifier.
questionId required	string <guid> The unique question identifier.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> The unique question identifier.
name	string The question name.
correctReply	string The correct reply to the question.
incorrectReply	string The incorrect reply to the question.
questionType	integer Enum: 0 1 2 The question type. Possible Enum Values: `0 = SingleAnswer` `1 = MultipleAnswer` `2 = Text`
attachment	string The attachment to use for the question. Note: URL or file.
	Array of objects (QuestionOptionResource) The question options.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"questionType": 0,
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}

Updates a question bank question

Authorizations:

api_key

path Parameters

questionId required	string <guid> The ID of the question.
questionBankId required	string <guid> The ID of the question bank.

header Parameters

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

Request Body schema: application/json

The request body to list question bank questions.

questionType required	string Enum: "SingleAnswer" "MultipleAnswer" "Text" Type of question. Possible Enum Values: `SingleAnswer = SingleAnswer` `MultipleAnswer = MultipleAnswer` `Text = Text`
name required	string [ 0 .. 4000 ] characters Name of the question.
correctReply	string [ 0 .. 2000 ] characters Correct reply to the question.
incorrectReply	string [ 0 .. 2000 ] characters Incorrect reply to the question.
attachment	string [ 0 .. 255 ] characters Attachment to use for the question. Note: URL or file.
required	Array of objects (QuestionOptions) The question options.

Responses

Response Schema: application/json

id	string <guid> The unique question identifier.
name	string The question name.
correctReply	string The correct reply to the question.
incorrectReply	string The incorrect reply to the question.
questionType	integer Enum: 0 1 2 The question type. Possible Enum Values: `0 = SingleAnswer` `1 = MultipleAnswer` `2 = Text`
attachment	string The attachment to use for the question. Note: URL or file.
	Array of objects (QuestionOptionResource) The question options.

Request samples

Payload

Content type

application/json

{"questionType": "SingleAnswer",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"questionType": 0,
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}

List question bank questions

Authorizations:

api_key

path Parameters

questionBankId

required

string <guid>

The unique question bank identifier.

query Parameters

_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 (QuestionBankQuestionResource) The paged collection of resources.

Response samples

200
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"questionBanks": [{"id": "string",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"questionType": 0,
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}
]
}

Create question bank question

Creates and returns a new question bank question.

Authorizations:

api_key

path Parameters

questionBankId

required

string <guid>

The ID of the question bank.

header Parameters

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

Request Body schema: application/json

The request body to create a new question bank question.

id	string <guid> The new question bank question's ID. If not supplied one will be created.
questionType required	string Enum: "SingleAnswer" "MultipleAnswer" "Text" Type of question. Possible Enum Values: `SingleAnswer = SingleAnswer` `MultipleAnswer = MultipleAnswer` `Text = Text`
name required	string [ 0 .. 4000 ] characters Name of the question.
correctReply	string [ 0 .. 2000 ] characters Correct reply to the question.
incorrectReply	string [ 0 .. 2000 ] characters Incorrect reply to the question.
attachment	string [ 0 .. 255 ] characters Attachment to use for the question. Note: URL or file.
required	Array of objects (QuestionOptions) The question options.

Responses

Response Schema: application/json

id	string <guid> The unique question identifier.
name	string The question name.
correctReply	string The correct reply to the question.
incorrectReply	string The incorrect reply to the question.
questionType	integer Enum: 0 1 2 The question type. Possible Enum Values: `0 = SingleAnswer` `1 = MultipleAnswer` `2 = Text`
attachment	string The attachment to use for the question. Note: URL or file.
	Array of objects (QuestionOptionResource) The question options.

Request samples

Payload

Content type

application/json

{"id": "string",
"questionType": "SingleAnswer",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}

Response samples

201
404

Content type

application/json

{"id": "string",
"name": "string",
"correctReply": "string",
"incorrectReply": "string",
"questionType": 0,
"attachment": "string",
"questionOptions": [{"id": "string",
"name": "string",
"isCorrect": true,
"order": 0
}
]
}