Absorb Integration API (v2)

Download OpenAPI specification:Download

Course Evaluations

Retrieves a list of evaluation answers for a specified course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

Course unique Identifier

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 (CourseEvaluationAnswerResource) The collection of course evaluation answer resources being included in the collection

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"answers": [{"id": "string",
"questionId": "string",
"rating": 0,
"userId": "string",
"text": "string"
}
]
}

Retrieves a single evaluation question for a specified course and question.

Authorizations:

api_key

path Parameters

courseId required	string <guid> The ID of the course.
questionId required	string <guid> The ID of the question.

header Parameters

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

Responses

Response Schema: application/json

id	string <guid> The unique identifier of the course evaluation question.
name	string The name of the course evaluation question.
order	integer <int32> The unique order of the course evaluation question.
type	integer Enum: 2 6 The type of course evaluation question. Possible Enum Values: `2 = Text` `6 = Rating`
totalResponses	integer <int32> The total number of responses to the question.

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"order": 0,
"type": 2,
"totalResponses": 0
}

Retrieves a list of evaluation questions for a specified course.

Authorizations:

api_key

path Parameters

courseId

required

string <guid>

The ID of the course.

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 (CourseEvaluationQuestionResource) The paged collection of course evaluation questions.

Response samples

200
404
422

Content type

application/json

{"totalItems": 0,
"returnedItems": 0,
"limit": 0,
"offset": 0,
"questions": [{"id": "string",
"name": "string",
"order": 0,
"type": 2,
"totalResponses": 0
}
]
}