🔵GET results

Fetches a list of results from the organisation.

URL

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

Parameters

Schema

Query Parameters

Name	Type	Description
startDate	string	Show only results after the date specified. Date is converted to a DateTimeOffset and supports specifying a time zone. ISO 8601 format is recommended.
endDate	string	Show only results before the date specified. Date is converted to a DateTimeOffset and supports specifying a time zone. ISO 8601 format is recommended.
reportingFilters	string[]	Show only results that have the specified filter answers. Note that a result only needs to match one of the specified answers. A list of available answers can be found using GET filters.
page	integer	The page of results to select. Defaults to the first page. 50 results are returned per page.

* required

Example

curl https://training.tapintosafety.com.au/api/v2/results        \
    -G -d "startDate=2022-08-01" -d "endDate=2022-08-31"         \
    -d "reportingFilters[]=00000000-0000-0000-0000-000000000000" \
    -d "page=2"                                                  \
    -H "Authorization: Bearer $APIKey"

Responses

200 - OK

A list of results from the database. List may be empty if no results are found for the specified parameters.

Schema

Name	Type	Description
entities	array	The list of the results returned.
┃ 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.
┃ dateCompleted	string	The completion time of this result. 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.
page	integer	The current page of results (Starts at 1).
entitiesReturned	integer	The number of courses in the entities array.
totalEntities	integer	The total entities across all pages for the current parameters.
links	array	A list of links relevant to the current request. No links are currently returned with this request.
┃ type	string	The type of the given link (e.g. Next Page, Previous Page).
┃ href	string	The URL to call for the given link.
┗ method	string	The HTTP method to use for the link (e.g. GET, POST).

Example

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "userId": "00000000-0000-0000-0000-000000000000",
      "courseId": "00000000-0000-0000-0000-000000000000",
      "multiCourseResultId": "00000000-0000-0000-0000-000000000000",
      "dateCompleted": "2022-09-15T07:04:24.696Z",
      "score": 5,
      "maximumScore": 10,
      "passRate": 80,
      "courseType": "SINGLE_COURSE"
      "resultFilters": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 1,
  "links": [
    {
      "type": "Next Page",
      "href": "https://training.tapintosafety.com.au/api/v2/results?page=2",
      "method": "GET"
    }
  ]
}