Get Attempt info
- 20 Aug 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get Attempt info
- Updated on 20 Aug 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get Attempt info
GET /api/v1/integrations/external/schedule/{externalId}/attempt-info
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| CandidateExtId | String | Candidate external id. The externalID corresponds with the 'User ID' within the usermanagement. |
Sample successfull Response
{
"Content": [
ExternalId: "EXT1",
FirstName: "testuser10",
LastName: "testuser10",
UserName: "testuser10",
Email: "email@email.com",
Attempts: [
AttemptNumber: 1,
StartDate: "2020-02-28T15:03:27.763Z",
EndDate: "2020-02-28T15:03:32.237Z",
Status: "HANDED_IN",
],
],
"Success": true,
"Errors": null
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible error codes: 202: User has not been found 203: User is not added to schedule 301:Schedule has not been found 303: Schedule is not activated 310: Schedule has not yet begun |
| 403 | Not allowed to use external API |
| 500 | Internal server error |
Was this article helpful?