API client can cross check attempted test in their system using these unique ids.
Note:- Datetime should be in UTC and should follow ISO 8601 format.
Example: 2018-02-15T16:00:00 (15th Feb 2018 04:00:00 PM)
Format: yyyy-MM-ddTHH:mm:ss
If no time part is included in request, API will assume time starts from 00:00:00
(24-hour format)
Field | Type | Required | Default | Description |
---|---|---|---|---|
StartDateTime | DateTime | Yes | - | Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ |
EndDateTime | DateTime | Yes | - | End datetime in UTC ISO 8601 Format Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ |
Field | Type | Description |
---|---|---|
state | completed | API will return all invites which were Completed/ Testleft/ Terminated |
state | cancelled | API will return all invites which were Cancelled |
state | expired | API will return all invites which were Expired |
URL 1: /v3/candidates/testattempts?state=completed
Request Body{ "StartDateTime":"2020-03-20T16:00:00Z", "EndDateTime":"2020-06-20T16:00:00Z" }
Status 200 OK
Response{ "result": { "testAttempts": [ { "testInvitationId": 2655161, "testId": 292930, "name": "May", "email": "[email protected]", "invitationtype":"api", "testStatus":"Completed" }, { "testInvitationId": 2894725, "testId": 1134601, "name": "Suhas Kurade", "email": "[email protected]", "invitationtype":"app", "testStatus":"Completed" } ] }, "errors": null }
Status 401 Unauthorized Request
If required parameters have invalid values.
Response{ "result": null, "errors": [ "Date & time is not invalid or incorrect format" ] }