Set Extra time for attempt
  • 30 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Set Extra time for attempt

  • Dark
    Light
  • PDF

Article summary

PUT /api/v1/integrations/external/schedule/{externalId}/setExtraTime

Request Parameters

Parameters indicated with a * are mandatory

ParameterTypeDescription
externalId*Stringschedule external id.

Request Parameters (for message body)

Parameters indicated with a * are mandatory

ParameterTypeDescription
CandidateExtIds*Array [string]External ids of candidates
ExtraTime*IntegerHow much time do you need to add for a candidate in minutes
CommentString]Comment

Sample Request

{
	"CandidateExtIds": ["7132", "notExist"],
	"ExtraTime": 150,
	"Comment": "Ne won't pass without it"
}

Sample successfull Response

{
  "Content": {
    "SuccessfullyUpdated": [
      "7132"
    ],
    "Errors": [
      {
        "CandidateExtId": "notExist",
        "Code": 202,
        "Error": "User has not been found"
      }
    ]
  },
  "Success": true,
  "Errors": null
}

Responses

CodeDescription
200Successful operation
400Possible error codes:
100: Request body can not be null or empty
200: Request does not contains any valid user external ids
300: ScheduleExternalId can not be null or empty
301: Schedule has not been found
302: Schedule is archived
303: Schedule is not activated
305: Schedule is finished
306: Schedule has unlimited time for attempt
403Not allowed to use external API
500Internal server error


Was this article helpful?