addComplianceItem
|
POST |
/api/widget/addComplianceItem |
Example of payload of data to the api in order to create a new compliance item linked to a Candidate.
Sample Request:
{
"trackerrms": {
"addComplianceItem": {
"credentials": {
"username": "",
"password": "",
"oauthtoken": "",
"apikey": ""
},
"record": {
"resourceId": 8,
"complianceItemId": 0,
"complianceItemName": "Passport",
"mandatory": true,
"dateCompleted": "2023-02-08",
"dateExpires": "2024-12-31",
"status": "Verified",
"notes": "59834958"
},
"file": {
"filename": "Passport Copy.pdf",
"data": "JVBERi0xLjUKJafj8fEKMiAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwo..."
}
}
}
}
Sample Response:
{
"status": 0,
"message": "success",
"count": 0
}
Response status codes:
|
0 |
success (message will be “created” or “updated”) |
|
1 |
user not found |
|
2 |
user not active |
|
3 |
record found and cannot be overwritten |
|
99 |
Invalid request |
File Information
"data" is a Base64 encoded binary (the file type will be determined by the "filename" provided).
ComplianceItemId/Name:
If you know the Id for the compliance item in Tracker you can use this, otherwise use the name of the Compliance Item as it appears in Tracker.