API Reference
Home

v1/assignment_groups/{id}/assign_employment

post
https://shyftplan.com/api/v1/assignment_groups//assign_employment

Assign employment to shifts of an assignment group.

Path Params
int32
required
≥ 1

ID of an assignment group.

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
required
≥ 1

ID of a shyftplan account.

int32
required
≥ 1

ID of the employment.

date-time
required

End date-time (ISO 8601) of the search period. Employee will only be added to those shifts of the assignment group that end before this date-time.

date-time
required

Start date-time (ISO 8601) of the search period. Employee will only be added to those shifts of the assignment group that start after this date-time.

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:

  • shifts_collision
  • absences_collision
  • locations_position_changed
  • minimum_break
  • maximum_working_hours
  • minimum_rest
  • maximum_earning
  • outside_employment_period
  • maximum_consecutive_working_days
  • restricted_shift_presets
  • unavailable
  • not_available
  • minimum_qualification_level
  • not_in_shift_preset

Response

Updated about 2 months ago

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

Updated about 2 months ago