/api/v1/employments/potential_conflicts_by_dates/get

post

https://shyftplan.com/api/v1/employments/potential_conflicts_by_dates/get

Returns potential conflicts for the referenced employees on each date in the given requests list, regarding a shift preset.

Body Params

user_email

string

required

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

E-mail address of the API user.

authentication_token

string

required

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

Authentication token - can be fetched by login action.

company_id

int32

≥ 1

ID of a shyftplan account.

conflicts

string | null

enum

required

Use this parameter, and set it to true, to check for all conflicts according to the company profile. To select a specific subset of conflict checks, use the other configuration of this endpoint, which will contain a conflicts array.

You must provide either conflicts or conflicts[].

Allowed:

requests

array of objects

required

length ≥ 1

A list of requests for conflicts checks

requests*

date

date-time

required

Date against which to perform the conflict check

shift_preset_id_per_employment

array of objects

required

length ≥ 1

A set of employees and one target shift preset

shift_preset_id_per_employment*

employment_ids

array of objects

required

length ≥ 1

List of employment IDs.

employment_ids*

shift_preset

int32

≥ 1

ID of a shift preset.

200Successfully listed

401Unauthorized

403Forbidden

404Not found