Certification types

Certification types are used to group similar types of certifications, for example qualifications, certificates, licenses, degrees. Use the API to return the full list of certification types, or add, update or delete a certification type.

Learn more about certification types in the OnLocation Help Center.

List all certification types

Retrieves a list of all certification types.

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.

Responses
200

List of certification types

403

Access denied to this resource

404

Resource not found

500

Internal server error

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

Create a certification type

Adds a new certification type to assign to a certification.

Request
Request Body schema: application/json

Type of certification to add:

name
string <string>
Responses
201

Certification type created

403

Access denied to this resource

500

Internal server error

post/certification/types
Request samples
application/json
{
  • "name": "Diploma"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 79,
  • "created": "2021-11-26T14:33:41+13:00",
  • "modified": "2022-11-26T14:33:41+13:00",
  • "name": "Certificate"
}

Retrieve a certification type

Retrieves a single certification type, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the certification type to retrieve

Responses
200

Certification type response

403

Access denied to resource

404

Resource not found

500

Internal server error

get/certification/types/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/certification/types/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 79,
  • "created": "2021-11-26T14:33:41+13:00",
  • "modified": "2022-11-26T14:33:41+13:00",
  • "name": "Certificate"
}

Update a certification type

Updates a single certification type.

Request
path Parameters
id
required
integer <int32>

ID of the certification type to update

Request Body schema: application/json

Information used to create the certification type record

name
string <string>
Responses
200

Updated certification type

403

Access denied to this resource

500

Internal server error

put/certification/types/{id}
Request samples
application/json
{
  • "name": "Diploma"
}
Response samples
application/json
application/json
application/xml
{
  • "id": 79,
  • "created": "2021-11-26T14:33:41+13:00",
  • "modified": "2022-11-26T14:33:41+13:00",
  • "name": "Certificate"
}

Delete a certification type

Deletes the specified certification type.

Request
path Parameters
id
required
integer <int32>

ID of the Certification Type to delete

Responses
204

Certification type deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

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