In this article, you can read about how to retrieve files attached to a candidate's interviews, how to upload a new file to an interview, and how to delete an existing interview file.
Get Candidate Interviews with Files
GET
https://api.recman.io/v2/get/index.php?key={{api_key}}&scope=
candidate&fields=interview&candidateId={{candidateId}}&page=1If there are files attached to an interview, these are listed by including fields=interview on a candidate request. File size is returned in bytes.
Note
This request lists only interview file metadata – it does not return the file content. Use the Download Candidate's Files request (documented under the Candidate scope) to actually download a file.
PARAMS
| Field | Description |
|---|---|
| key required | {{api_key}} |
| scope required | candidate |
| fields required | interview |
| candidateId required | {{candidateId}} |
| page required | 1 |
Insert Interview File
POST
https://api.recman.io/v2/post/Adds a file to one of the candidate's interviews. The response includes the new interviewFileId and fileId values.
Note
To obtain a candidate's interview IDs, use the Get Candidate request with the fields=interview query parameter included (see above).
| URL POST | https://api.recman.io/v2/post/ |
| Scope | candidate |
| Operation | insert |
Fields
| Field | Description |
|---|---|
| candidateId integer | Candidate ID required |
| file object | The file to attach; see sub-fields below |
file — sub-fields
| Field | Description |
|---|---|
| name string | File name |
| ext string | File extension, e.g. jpeg |
| created date-time | Creation date and time. Format: Y-m-d H:i:s |
| interviewId string | ID of the interview to attach the file to |
| base64 string | Base64-encoded content of the file |
Request Body
| key | {{api_key}} |
| scope | candidate |
| operation | insert |
| data.candidateId | {{candidateId}} |
| data.file.name | API added document |
| data.file.ext | jpeg |
| data.file.created | 2022-03-16 18:50:00 |
| data.file.interviewId | 622304 |
| data.file.base64 | <base64-encoded file content> |
Delete Interview File
POST
https://api.recman.io/v2/post/Deletes a previously uploaded interview file.
Note
To obtain a candidate's interview and attached file IDs, use the Get Candidate request with thefields=interview query parameter included (see above).
| URL POST | https://api.recman.io/v2/post/ |
| Scope | candidateInterviewFile |
| Operation | delete |
Fields
| Field | Description |
|---|---|
| candidateId integer | Candidate ID required |
| interviewId integer | Interview ID required |
| interviewFileId integer | Interview file ID required |
Request Body
| key | {{api_key}} |
| scope | candidateInterviewFile |
| operation | delete |
| data.candidateId | {{candidateId}} |
| data.interviewId | 622304 |
| data.interviewFileId | 13941 |