- Previous: POST Candidates
- Up: Candidate APIs
- Next: GET Candidates
GET Candidate Submission Results
Description: Retrieve Candidate Submission Results
Sample CURL:
curl -X POST "https://uat.vmsapi.vectorvms.com/candidateresults?batchid={entered batchid}" -H "accept: application/json" -H "x-api-key: {your_api_key}" -H "x-signature: {your_api_signature}"
Parameter | Description |
---|---|
batchid |
Batch Id from POST Candidate results |
x-api-key |
Your API key (found in My Account) |
x-signature |
Signature (Key+Secret+Timestamp Hash) - refer to Authentication section of Documentation for more information |
Response Code 200 - Schema
Response Field | Description |
---|---|
Batch_Id | Batch Id of returned candidate results. |
CandErrorMessage | Error message returned for any issues occuring during candidate submittal |
Cand_Id | VMS Candidate ID for submitted candidate |
Cand_Status | Status of Candidate Submission: Pending – Awaiting submission New – Candidate submitted Incomplete – Candidate submitted with incomplete data Error – Candidate not submitted due to error |
Vendor_Candidate_Id | Vendor Candidate ID for submitted candidate |
- Previous: POST Candidates
- Up: Candidate APIs
- Next: GET Candidates