Requests

This section contains a detailed technical explanation of all the endpoints necessary to manage the information related to requests through the API.

Considerations

The structure of a request in the Orquest API has the following information:

  • employeeId: external identifier of the employee.

  • status: status of the request. The possible values are REQUESTED, GRANTED and DENIED.

  • type: type of availability that applies to the request. The possible values are MANDATORY, MAYBE and NON_WORKED.

  • from: start date of the request in yyyy-MM-dd format.

  • to: end date of the request in yyyy-MM-dd format.

  • fromHour: start time of the request in HH:mm format. Refers to local time, that is, the time zone of the service.

  • toHour: end time of the request in HH:mm format. Refers to local time, that is, the time zone of the service.

  • comments: reason or explanation for making the request.

  • recover: type of recovery indicating how the employee’s request could be compensated. The options are FREE (free day) or NONE.