This page describes the API for Shiftadviser in Version 1. It is a REST interface with the three endpoints "optimize", "status", and "retrieve". The intended use is that the "optimize" endpoint shall be called to submit a new instance of the shift scheduling problem (in JSON form). A jobId is returned. With the endpoint "status", the current state of a submission can be polled using the jobId. Finally, if the status is "finished", the "retrieve" endpoint shall be called to fetch the solution of the given instance with the jobId.

All calls to the endpoints require an API-token in the header. Such a token can be obtained by writing a request to kontakt@shiftadviser.com.

1. Optimize

Request
Method	POST
URL	https://api.shiftadviser.com/v1/optimize
Header	key: content-type, value: application/json key: api-token, value: your_individual_token
Body	raw: your_instance_in_JSON_form, see an example here
Response
Status	202 Accepted
Header	key: content-type, value: application/json
Body	raw: JSON_containing_jobId
Example
Postman

2. Status

Request
Method	GET
URL	https://api.shiftadviser.com/v1/status
Header	key: api-token, value: your_individual_token
URL-Parameter	key: jobId, value: jobId_from_optimize_call
Response
Status	202 Accepted
Header	key: content-type, value: application/json
Body	raw: JSON_containing_jobId
Example
Postman

3. Retrieve

Request
Method	GET
URL	https://api.shiftadviser.com/v1/retrieve
Header	key: api-token, value: your_individual_token
URL-Parameter	key: jobId, value: jobId_from_optimize_call
Response
Status	202 Accepted
Header	key: content-type, value: application/json
Body	raw: JSON_containing_planning
Example
Postman