🔵GET result

Fetches a list of results from the organisation.

URL

GET https://training.tapintosafety.com.au/api/v2/results/{resultId}

Parameters

Schema

Query Parameters

Name	Type	Description
resultId	string	The ID of the result to fetch the details for. This must be formatted as a full and valid GUID, and a result with the given ID must exist.

* required

Example

Responses

200 - OK

A result from the database.

Schema

Name	Type	Description
id	string	The Id of the result. Formatted as a GUID.
userId	string	The Id of the user the result is for. Formatted as a GUID.
courseId	string	The Id of the course the result is for. Formatted as a GUID.
multiCourseResultId	string	The Id of the parent result if this result is part of a multi-course module. Formatted as a GUID.
isComplete	boolean	Whether the user has completed the course for this result.
dateCompleted	string	The completion time of this result, or the start time if isComplete is false. Formatted in ISO 8601.
score	integer	The score the user obtained for this result.
maximumScore	integer	The maximum possible score for this result.
passRate	integer	The pass rate in percent from 0-100, or null if the organisation has not specified a pass rate.
courseType	string	The type of the course. (SINGLE_COURSE or MULTI_COURSE)
resultFilters	string[]	A list of the filter answers the user had at the time of completion.

Example

400 - Bad Request

Error Code: INVALID_MODEL

One or more parameters provided are invalid. See details for more information.

404 - Not Found

Error Code: INVALID_MODEL

One or more parameters provided are invalid. See details for more information.