Certification holders

Certifications can be assigned to employees and contractors. Each certification record includes the dates that the certification is valid for, along with the person's name, email, and if there are any documents attached to the record. Use the API to see which employees and contractors hold each certification, or create, update or delete a certification holder record.

Learn more about certification holders in the OnLocation Help Center.

List all certification holders

Returns a list of the employees or contractors that hold the specified certification.

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 certification to retrieve holders for

Example: 5
Responses
200

List of employees or contractors that hold the certification

403

Access denied to resource

404

Resource not found

500

Internal server error

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

Create a certification holder

Adds a new certification holder association.

Request
path Parameters
id
required
integer <int32>

ID of the certification to create a holder association for

Request Body schema: application/json
record_id
integer <int32>

This is the ID of the staff or contractor member being given the qualification

record_type
string
Enum: "staff" "sp"
validfrom
string <date>
validto
string <date>
certification_number
string <string>
Responses
201

Resource created

403

Access denied to this resource

500

Internal server error

post/certification/{id}/holder
Request samples
application/json
{
  • "record_id": 823431,
  • "record_type": "staff",
  • "validfrom": "2021-11-27",
  • "validto": "2022-11-27",
  • "certification_number": "WFL900"
}
Response samples
application/json
{
  • "id": 218,
  • "created": "2021-11-26T14:37:12+13:00",
  • "modified": "2021-11-30T14:37:12+13:00",
  • "certification_id": 1205,
  • "record_id": 823431,
  • "record_type": "staff",
  • "validfrom": "2021-11-27",
  • "validto": "2022-11-27",
  • "certification_number": "WFL900",
  • "holder_name": "Robert Jordan",
  • "holder_email": "example-email@whosonlocation.com",
  • "certification_name": "Window Fitting Licence",
  • "type": "Licence",
  • "documents": 1
}

Retrieve a certification holder

Retrieves the details of a specific certification holder

Request
path Parameters
id
required
integer <int32>

ID of the certification to retrieve holders for

hid
required
integer <int32>

ID of the certification holder to retrieve

Responses
200

Details of the certification holder

403

Access denied to resource

404

Resource not found

500

Internal server error

get/certification/{id}/holder/{hid}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/certification/:id/holder/:hid
Response samples
application/json
application/json
application/xml
{
  • "id": 218,
  • "created": "2021-11-26T14:37:12+13:00",
  • "modified": "2021-11-30T14:37:12+13:00",
  • "certification_id": 1205,
  • "record_id": 823431,
  • "record_type": "staff",
  • "validfrom": "2021-11-27",
  • "validto": "2022-11-27",
  • "certification_number": "WFL900",
  • "holder_name": "Robert Jordan",
  • "holder_email": "example-email@whosonlocation.com",
  • "certification_name": "Window Fitting Licence",
  • "type": "Licence",
  • "documents": 1
}

Update a certification holder

Updates a certification holder's details.

Request
path Parameters
id
required
integer <int32>

ID of the certification

hid
required
integer <int32>

ID of the certification holder association to update

Request Body schema: application/json

Information used to create the certification holder association

record_id
integer <int32>

This is the ID of the staff or contractor member being given the qualification

record_type
string
Enum: "staff" "sp"
validfrom
string <date>
validto
string <date>
certification_number
string <string>
Responses
200

Updated resource

403

Access denied to this resource

500

Internal server error

put/certification/{id}/holder/{hid}
Request samples
application/json
{
  • "record_id": 823431,
  • "record_type": "staff",
  • "validfrom": "2021-11-27",
  • "validto": "2022-11-27",
  • "certification_number": "WFL900"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 218,
  • "created": "2021-11-26T14:37:12+13:00",
  • "modified": "2021-11-30T14:37:12+13:00",
  • "certification_id": 1205,
  • "record_id": 823431,
  • "record_type": "staff",
  • "validfrom": "2021-11-27",
  • "validto": "2022-11-27",
  • "certification_number": "WFL900",
  • "holder_name": "Robert Jordan",
  • "holder_email": "example-email@whosonlocation.com",
  • "certification_name": "Window Fitting Licence",
  • "type": "Licence",
  • "documents": 1
}

Delete a certification holder

Deletes the specified certification holder association record.

Request
path Parameters
id
required
integer <int32>

ID of the certification

hid
required
integer <int32>

ID of the certification holder association to delete

Responses
204

Certification holder deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

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