Qualification holders (deprecated)

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

List all qualification holdersDeprecated

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

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

Example: 5
Responses
200

List of employees or contractors that hold the qualification

403

Access denied to this resource

404

Resource not found

500

Internal server error

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

Create a qualification holderDeprecated

Adds a new qualification holder association.

Request
path Parameters
id
required
integer <int32>

ID of the qualification to create a holder association for

Request Body schema: application/json

Information use to create the qualification 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
201

Qualification holder created

403

Access denied to this resource

500

Internal server error

post/qualification/{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 qualification holderDeprecated

Retrieves the details of a specific qualification holder.

Request
path Parameters
id
required
integer <int32>

ID of the qualification to retrieve holders for

hid
required
integer <int32>

ID of the qualification holder to retrieve

Responses
200

List of employees or contractors that hold the qualification

403

Access denied to this resource

404

Resource not found

500

Internal server error

get/qualification/{id}/holder/{hid}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/qualification/: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 qualification holderDeprecated

Updates a qualification holder's details.

Request
path Parameters
id
required
integer <int32>

ID of the qualification

hid
required
integer <int32>

ID of the qualification holder association to update

Request Body schema: application/json

Information use to create the qualification 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/qualification/{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 qualification holderDeprecated

Deletes the specified qualification holder association record.

Request
path Parameters
id
required
integer <int32>

ID of the qualification

hid
required
integer <int32>

ID of the qualification holder association to delete

Responses
204

Qualification holder deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

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

List all qualification documentsDeprecated

Retrieves a list of documents for a specified qualification holder and specified qualification.

Request
path Parameters
id
required
integer <int32>

ID of the qualification

hid
required
integer <int32>

ID of the qualification holder

Responses
200

List of qualification holder documents

403

Access denied to resource

404

Resource not found

500

Internal server error

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