Certification holder documents

Each certification added to an employee or contractor profile can have a document attached. Use the API to return a list of certification documents, and update or delete a certification document.

Learn more about certification documents in the OnLocation Help Center.

List of certification documents

Retrieves a list of documents for a specified certification holder and specified certification

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

List of certification holder documents

403

Access denied to resource

404

Resource not found

500

Internal server error

get/certification/{id}/holder/{hid}/document

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api.whosonlocation.com/v1/certification/:id/holder/:hid/document

Response samples

[{"id": 70,
"modified": "2021-11-29T08:12:24+13:00",
"name": "file-example",
"type": "pdf",
"size": 469513,
"link": "https://your.site.com/storage/file-example.pdf"
}
]

Adds a certification document

Adds a new certification holder document.

Request

path Parameters

id required	integer <int32> ID of the certification
hid required	integer <int32> ID of the certification holder

Request Body schema: multipart/form-data

file

required

string <file>

file to upload

Responses

200

Document added

403

Access denied to this resource

500

Internal server error

post/certification/{id}/holder/{hid}/document

Request samples

curl
JavaScript
Node.js

curl -i -X POST \
  https://api.whosonlocation.com/v1/certification/:id/holder/:hid/document \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Retrieve a certification document

Retrieves a certification holder document, filtering with the provided ID

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
did required	integer <int32> ID of the document to retrieve

Responses

200

The specified document to be retrieved

403

Access denied to resource.

404

Resource not found

500

Internal server error

get/certification/{id}/holder/{hid}/document/{did}

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  https://api.whosonlocation.com/v1/certification/:id/holder/:hid/document/:did

Response samples

{"id": 70,
"modified": "2021-11-29T08:12:24+13:00",
"name": "file-example",
"type": "pdf",
"size": 469513,
"link": "https://your.site.com/storage/file-example.pdf"
}

Delete a certification document

Deletes the specified certification holder document.

Request

path Parameters

id required	integer <int32> ID of the certification
hid required	integer <int32> ID of the certification holder association
did required	integer <int32> ID of the document to delete

Responses

204

Resource Deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

delete/certification/{id}/holder/{hid}/document/{did}

Request samples

curl
JavaScript
Node.js

curl -i -X DELETE \
  https://api.whosonlocation.com/v1/certification/:id/holder/:hid/document/:did