In this article, you can read about how to retrieve a candidate's certifications together with their attached files, upload new certification files, and delete existing certification files via the API.
Get Certifications with Files
GET
https://api.recman.io/v2/get/index.php?scope=candidate&
key={{api_key}}&page=1&candidateId={{candidateId}}&
fields=certificationGet a list of a candidate's certifications with attached files included. Each file in the response includes a candidateFileId, which can then be used with the Download Candidate's Files request (see Candidates: Updating, Deleting, and Managing Files via the API) to retrieve the actual file content.
PARAMS
| scope | candidate required |
| key | {{api_key}} required |
| page | 1 required |
| candidateId | {{candidateId}} required |
| fields | certification required |
Each certification returned includes a certificationId, name, endDate, description, and candidateAccess flag, along with a files array. Each file entry contains a certificationFileId, name, ext, size, and the candidateFileId used for downloading.
Upload Certification Files
POST
https://api.recman.io/v2/post/Upload a file to attach to a candidate's certificate. This uses the candidate scope with the insert operation, nesting the file under an existing certification via its certificationId. On success, the response returns a fileId and a certificationFileId.
Note
To obtain a candidate's certificationId, use the Get Certifications with Files request above.
Field
| file | object |
Sub Fields
| Sub Fields | Description |
|---|---|
| certificationId integer |
Required — the ID of the certification the file should be attached to |
| name string |
Required — name of the file |
| ext string |
Required — file extension, e.g. pdf, jpeg |
| base64 string |
Required — base64-encoded file content |
| created date-time |
Optional. Format: Y-m-d H:i:s |
Delete Certification File
POST
https://api.recman.io/v2/post/Delete an uploaded certification file. This uses its own scope, candidateCertificationFile, with the delete operation.
Note
To obtain a candidate's certification and attached file IDs, use the Get Certifications with Files request above.
Parameters
| scope | candidateCertificationFile required |
| operation | delete required |
| candidateId | {{candidateId}} required |
| certificationId | 2096777 required |
| certificationFileId | 323153 required |