API Reference
Home

v1/evaluations/{staff_shift_id}

post
https://shyftplan.com/api/v1/evaluations/

Sets an evaluation for a StaffShift

Path Params
int32
required
Query Params
evaluation_tag_ids[]
array of int32s

Array of EvaluationTag IDs

evaluation_tag_ids[]
Body Params
string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

int32
≥ 1

ID of a shyftplan account.

date-time
required

End of the Evaluation

date-time
required

Start of the Evaluation

int32

Break duration in minutes

evaluation_breaks
array of objects

Array of timed breaks

evaluation_breaks
string
Defaults to false

Either true to ignore all conflicts listed below or an Array of specific conflicts to ignore. Only warnings can be ignored, enforced conflicts will persist. Possible values are:

  • minimum_break

string

Comment

payments
array of objects

Array of payments

payments
int32

Duration of untimed breaks in minutes

boolean
Defaults to false

Boolean value to only save details for the staff shift (true) or to create an evaluation on saving (false, default).

Responses

Updated 15 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago