Induction holders

An induction holder is someone who has completed an induction course. Induction holder records include the learner's name, email, status odf the course, the number of attempts, when it's due to be renewed. Use the API to retrieve who has completed each induction course, or create, update or delete an induction holder record.

Learn more about induction holders in the OnLocation Help Center.

List all induction holders

Retrieves a list of all employees and contractors that hold the specified induction.

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
path Parameters
id
required
integer <int32>

ID of the induction course

query Parameters
q
string <string>

Filter by induction holder value.

Example: q=holders>5
Responses
200

List of induction holder details

403

Access denied to resource

404

Resource not found

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

Create an induction holder

Creates an induction holder association. If an association already exists, the existing record will be updated.

Request
path Parameters
id
required
integer <int32>

ID of the induction course

Request Body schema: application/json

Information used to create induction holder association:

staff_id
integer <int32>
sp_member_id
integer <int32>
completed
string <date-time>
Responses
201

Induction created

403

Access denied to this resource

500

Internal server error

post/induction/{id}/holder
Request samples
application/json
{
  • "staff_id": 55,
  • "sp_member_id": 3001,
  • "completed": "2021-11-25T22:01:09.385Z"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 6856,
  • "completed": "2021-11-26T00:00:00+13:00",
  • "staff_id": 35,
  • "sp_member_id": 642,
  • "learner_name": "Robert Jordan",
  • "learner_email": "example.email@whosonlocation.com",
  • "learner_title": "Mr",
  • "learner_from": "OnLocation",
  • "status": "passed",
  • "attempts": 1,
  • "attempts_left": 0,
  • "renew": "2022-11-26"
}

Retrieve an induction holder

Retrieves a single induction holder record, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the induction course

hid
required
integer <int32>

ID of the induction holder association to retrieve

Responses
200

Induction holder details

403

Access denied to resource

404

Resource not found

500

Internal server error

get/induction/{id}/holder/{hid}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/induction/:id/holder/:hid
Response samples
application/json
application/json
application/xml
{
  • "id": 6856,
  • "completed": "2021-11-26T00:00:00+13:00",
  • "staff_id": 35,
  • "sp_member_id": 642,
  • "learner_name": "Robert Jordan",
  • "learner_email": "example.email@whosonlocation.com",
  • "learner_title": "Mr",
  • "learner_from": "OnLocation",
  • "status": "passed",
  • "attempts": 1,
  • "attempts_left": 0,
  • "renew": "2022-11-26"
}

Update induction holder

Updates an induction holder association

Request
path Parameters
id
required
integer <int32>

ID of the induction course

hid
required
integer <int32>

ID of the induction holder association

Request Body schema: application/json

Information used to create Induction holder association:

completed
string <date-time>
staff_id
string <integer>
sp_member_id
string <integer>
Responses
200

Updated induction holder

403

Access denied to this resource

500

Internal server error

put/induction/{id}/holder/{hid}
Request samples
application/json
{
  • "completed": "2021-11-25T22:01:09.385Z",
  • "staff_id": "123",
  • "sp_member_id": "123"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 6856,
  • "completed": "2021-11-26T00:00:00+13:00",
  • "staff_id": 35,
  • "sp_member_id": 642,
  • "learner_name": "Robert Jordan",
  • "learner_email": "example.email@whosonlocation.com",
  • "learner_title": "Mr",
  • "learner_from": "OnLocation",
  • "status": "passed",
  • "attempts": 1,
  • "attempts_left": 0,
  • "renew": "2022-11-26"
}

Delete an induction holder

Deletes the specified induction holder association.

Request
path Parameters
id
required
integer <int32>

ID of the induction course

hid
required
integer <int32>

ID of the induction holder association to delete

Responses
204

Induction holder association deleted

403

Access denied to resource

404

Resource not found

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