Public
Events

Get non-working days for all members (employees)

Changed on

Returns one entry per non-working calendar day per member, for all active members in the group, over the given date range (fromDate and toDate are both inclusive). A day is considered non-working for a member when they have no assigned shift anchored to that day (per the group's ShiftOverTwoDaysOption setting) that was not marked absent.This endpoint uses POST to allow large values in its body parameters

post/v1/public/events/non-working-days/get

Request

  • Base URL
    https://api.evolia.com
  • Auth
    HTTP basic

Request body

fromDatestring required

a date in ISO-8601 format (2021-01-31T00:00:00.000-05:00). The calendar date (in the group timezone) of this date is the first day included in the result.

toDatestring required

a date in ISO-8601 format (2021-02-07T00:00:00.000-05:00). The calendar date (in the group timezone) of this date is the last day included in the result.

excludeEmployeeCodesstring[]

if specified, members whose employee code is in this list are excluded from the result

forTeamIdsstring[]

if specified, use this array of team UIDs to only get non-working days for members linked to those teams

forTeamCodesstring[]

if specified, use this array of team codes to only get non-working days for members linked to those teams. (forTeamIds will take precedence over forTeamCodes if set)

forLocationIdsstring[]

if specified, use this array of location UIDs to only get non-working days for members linked to those locations

forLocationCodesstring[]

if specified, use this array of location codes to only get non-working days for members linked to those locations. (forLocationIds will take precedence over forLocationCodes if set)

forSkillIdsstring[]

if specified, use this array of skill UIDs to only get non-working days for members linked to those skills (positions)

forSkillCodesstring[]

if specified, use this array of skill codes to only get non-working days for members linked to those skills (positions). (forSkillIds will take precedence over forSkillCodes if set)

Example request

{
  "fromDate": "2021-01-31T00:00:00.000-05:00",
  "toDate": "2021-02-07T00:00:00.000-05:00",
  "excludeEmployeeCodes": [],
  "forTeamIds": [],
  "forTeamCodes": [],
  "forLocationIds": [],
  "forLocationCodes": [],
  "forSkillIds": [],
  "forSkillCodes": []
}

Response

firstNamestring required

the member (employee) first name

lastNamestring required

the member (employee) last name

uidstring required

unique member (employee) id

codeobject

the member (employee) code

externalIdobject required

The member (employee) externalId. The externalId is often used as a mapping value between Evolia and an external system

datestring required

the non-working calendar date, in YYYY-MM-DD format

Changes