🔵GET courses

Fetches a list of courses available to the organisation.

URL

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

Parameters

Schema

Query Parameters

Name	Type	Description
categoryType	string	Filter the courses returned by category.
name	string	Filter the courses returned by name.

Example

curl https://training.tapintosafety.com.au/api/v2/courses \
    -G -d "categoryType=safety-training" -d "name=Safety" \
    -H "Authorization: Bearer $APIKey"

Responses

200 - OK

A list of courses from the database. List may be empty.

Schema

Name	Type	Description
entities	array	The list of the courses returned.
┃ id	string	The Id of the course. Formatted as a GUID.
┃ name	string	The name of the course.
┃ passRate	integer	The pass rate in percent from 0-100, or null if the organisation has not specified a pass rate.
┗ categories	array	A list of the categories the course belongs to.
┃ type	string	The type of the category. Can be used for the categoryType filter.
┗ name	string	The display name of the category.
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.

Example

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Example Name",
      "passRate": 80,
      "categories": [
        {
          "type": "example-category",
          "name": "Example Category"
        }
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 1,
  "links": []
}