Qualifications (deprecated)

The qualifications endpoints have been deprecated as Qualifications Management has been renamed Certifications Management. Use the certifications endpoints to access this data.

List all qualificationsDeprecated

Returns a list of all qualifications.

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 qualification value.

Example: q=holders>5
Responses
200

List of qualifications

403

Access denied to this resource

404

Resource not found

500

Internal server error

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

Create a qualificationDeprecated

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

Request
Request Body schema: application/json

Information to use when creating a new qualification record:

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

Resource created

403

Access denied to this resource

500

Internal server error

post/qualification
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": "Qualification Name",
  • "category": "external",
  • "description": "This describes the certification",
  • "holders": 2,
  • "status": "Active"
}

Retrieve a qualificationDeprecated

Retrieves a single qualification, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the qualification to retrieve

Responses
200

Qualification returned

403

Access denied to resource

404

Resource not found

500

Internal server error

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

Update a qualificationDeprecated

Updates the details of a qualification.

Request
path Parameters
id
required
integer <int32>

ID of the qualification to update

Request Body schema: application/json

Qualification information to use when updating a qualification record:

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

Updated qualification

403

Access denied to this resource

500

Internal server error

put/qualification/{id}
Request samples
application/json
{
  • "name": "Updated Request",
  • "category": "external",
  • "certification_type_id": 81,
  • "description": "This describes the certification"
}
Response samples
application/json
application/json
application/xml
{
  • "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",
  • "staff_audience": "locations",
  • "contractor_audience": "groups",
  • "staff_departments": [
    ],
  • "staff_locations": [
    ],
  • "staff_roles": [
    ],
  • "sp_groups": [
    ],
  • "sp_locations": [
    ],
  • "sp_roles": [
    ]
}

Delete a qualificationDeprecated

Deletes a qualification using the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the qualification to delete

Responses
204

Qualification deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

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