API documentation (0.1)

Download OpenAPI specification:Download

Explore OnLocation's API reference documentation. References include:

  • Certifications
  • Custom questionnaires
  • Custom fields
  • Contractors
  • Employees
  • Inductions
  • Locations
  • Notifications
  • Visitors

Certifications

Certifications are used to record employee and contractor accreditations in OnLocation. Use the API to retrieve the certifications created for your organization, add or update, or delete a certification, see the number of people who hold the certification.

Learn more about certifications in the OnLocation Help Center.

List all certifications

Returns a list of all certifications.

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 any certification value.

Example: q=holders>5
Responses
200

List of certifications

403

Access denied to resource

404

Resource not found

500

Internal server error

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

Create a certification

Creates a new certification that can be assigned to employees or contractors.

Request
Request Body schema: application/json

Information to use when creating a new certification record.

name
string <string>
category
string <string>
certification_type_id
integer <int32>
description
string <string>
Responses
201

Certification created

403

Access denied to this resource

500

Internal server error

post/certification
Request samples
application/json
{
  • "name": "Updated Request",
  • "category": "external",
  • "certification_type_id": 81,
  • "description": "This describes the certification"
}
Response samples
application/json
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "created_by": 35,
  • "name": "Certification Name",
  • "category": "internal",
  • "certification_type_id": 81,
  • "description": "This describes the certification",
  • "holders": 2,
  • "status": "Active"
}

Retrieve a certification

Retrieves a single certification, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the certification to retrieve

Responses
200
403

Access denied to resource

404

Resource not found

500

Internal server error

get/certification/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/certification/:id
Response samples
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "created_by": 35,
  • "name": "Certification Name",
  • "category": "internal",
  • "certification_type_id": 81,
  • "description": "This describes the certification",
  • "holders": 2,
  • "status": "Active"
}

Update a certification

Updates the details of a certification.

Request
path Parameters
id
required
integer <int32>

ID of the certification to update

Request Body schema: application/json

Information used to create the certification record

name
string <string>
category
string <string>
certification_type_id
integer <int32>
description
string <string>
Responses
200

Updated resource

403

Access denied to this resource

500

Internal server error

put/certification/{id}
Request samples
application/json
{
  • "name": "Updated Request",
  • "category": "external",
  • "certification_type_id": 81,
  • "description": "This describes the certification"
}
Response samples
{
  • "id": 1206,
  • "created": "2021-11-26T14:35:28+13:00",
  • "modified": "2021-12-31T14:35:28+13:00",
  • "created_by": 35,
  • "name": "Certification Name",
  • "category": "internal",
  • "certification_type_id": 81,
  • "description": "This describes the certification",
  • "holders": 2,
  • "status": "Active"
}

Delete a certification

Deletes a certification using the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the certification to delete

Responses
204

Certification deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

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