Induction courses

Induction courses are to record if an employee or contractor has completed required training. There are four types of induction course in OnLocation: internal, external, eLearning and SCORM Cloud. The first two options are used to record that training has been completed; last two options are used to deliver online training. An induction course record includes the basic course information, it doesn't include any course content.

Use the induction API to retrieve your induction course list, create an induction course, and update or delete an induction course. You can also return a list of learners that hold a specific induction, add inductions to employee or contractor profiles, and update or delete a specific learner record.

Learn more about induction courses in the OnLocation Help Center.

List all induction courses

Returns a list of all induction courses.

A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.

Request
query Parameters
q
string <string>

Filter by induction course field.

Example: q=type:external
Responses
200

List of induction courses

403

Access denied to this resource

404

Resource not found

get/induction
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/induction?q=string'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Create an induction course

Create a new induction course, including the name, description, audience, and renewal settings.

Request
Request Body schema: application/json

Induction course details:

name
string <string>
type
string <string>
description
string <string>
status
string <string>
audience_staff
string <string>
audience_sp
string <string>
renew
integer <int32>
audience_staff_member
Array of any <int32>
audience_sp_member
Array of any <int32>
Responses
201

Induction course created

403

Access denied to this resource

500

Internal server error

post/induction
Request samples
application/json
{
  • "name": "Employee induction course",
  • "type": "internal/external",
  • "description": "Induction course description",
  • "status": "inactive",
  • "audience_staff": "all/location/department/role/none",
  • "audience_sp": "all/location/group/role/none",
  • "renew": 12,
  • "audience_staff_member": [
    ],
  • "audience_sp_member": [
    ]
}
Response samples
application/json
{
  • "id": 184,
  • "created": "2021-11-03T13:19:14+13:00",
  • "modified": "2021-11-10T12:22:08+13:00",
  • "setup_by": 773,
  • "name": "Employee induction course",
  • "type": "online",
  • "description": "Induction course description",
  • "status": "inactive",
  • "audience_staff": "all",
  • "audience_sp": "all",
  • "renew": 12,
  • "attempts": 1,
  • "inductees": 3,
  • "audience_staff_member": [
    ],
  • "audience_sp_member": [
    ]
}

Retrieve an induction course

Retrieves a single induction course, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the induction to retrieve

Responses
200

Course returned

403

Access denied to resource

404

Resource not found

get/induction/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/induction/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 184,
  • "created": "2021-11-03T13:19:14+13:00",
  • "modified": "2021-11-10T12:22:08+13:00",
  • "setup_by": 773,
  • "name": "Employee induction course",
  • "type": "online",
  • "description": "Induction course description",
  • "status": "inactive",
  • "audience_staff": "all",
  • "audience_sp": "all",
  • "renew": 12,
  • "attempts": 1,
  • "inductees": 3,
  • "audience_staff_member": [
    ],
  • "audience_sp_member": [
    ]
}

Update an induction course

Updates an induction course based on the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the induction course to update

Request Body schema: application/json

Induction to save to the database

name
string <string>
type
string <string>
description
string <string>
status
string <string>
audience_staff
string <string>
audience_sp
string <string>
renew
integer <int32>
audience_staff_member
Array of any <int32>
audience_sp_member
Array of any <int32>
Responses
200

Updated induction course

403

Access denied to this resource

500

Internal server error

put/induction/{id}
Request samples
application/json
{
  • "name": "Employee induction course",
  • "type": "internal/external",
  • "description": "Induction course description",
  • "status": "inactive",
  • "audience_staff": "all/location/department/role/none",
  • "audience_sp": "all/location/group/role/none",
  • "renew": 12,
  • "audience_staff_member": [
    ],
  • "audience_sp_member": [
    ]
}
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Delete an induction course

Deletes the specified induction course.

Request
path Parameters
id
required
integer <int32>

ID of the induction course to delete

Responses
204

Induction course deleted

403

Access denied to resource

404

Resource not found

delete/induction/{id}
Request samples
curl -i -X DELETE \
  https://api.whosonlocation.com/v1/induction/:id