🔵GET results/group

Fetches a list of results from the organisation for a specific group.

This endpoint does not show individual course completions and instead averages the all results for a course matching the specified parameters. If you wish to see all results individually you can use Group Id in the reportingFilters parameter for the GET results endpoint.

URL

GET https://training.tapintosafety.com.au/api/v2/results/group/{Group Id}

Parameters

Schema

URL Parameters

Name	Description
Group Id*	The Id of the group to fetch results for. Formatted as a GUID. A list of groups can be found using GET groups.

* required

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.

Example

curl https://training.tapintosafety.com.au/api/v2/results/group/00000000-0000-0000-0000-000000000000 \
    -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.
┃ groupId	string	The Id of the group specified in Group Id. Formatted as a GUID.
┃ courseId	string	The Id of the course this aggregate is for. Formatted as a GUID.
┃ completions	integer	The number of results in the aggregate.
┃ score	double	The average score of all results in the aggregate.
┃ maximumScore	integer	The maximum score achievable for the course.
┗ courseType	string	The type of the course. (SINGLE_COURSE or MULTI_COURSE)
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,
      "resultFilters": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 2,
  "links": [
    {
      "type": "Next Page",
      "href": "https://training.tapintosafety.com.au/api/v2/results?page=2",
      "method": "GET"
    }
  ]
}

400 - Bad Request

Error Code: INVALID_GROUP

The group specified with Group Id could not be found.