नेविगेशन पर जाएँ
ReceptionHolidays

Get All Holidays

Get all holidays/time-off entries for the current workspace with optional filters

हेडर

xi-api-keystringवैकल्पिक
xi-workspace-idstring or nullवैकल्पिक
The customer workspace a reseller's API key acts on.

क्वेरी पैरामीटर

start_unixinteger or nullवैकल्पिक
Filter entries overlapping from this timestamp
end_unixinteger or nullवैकल्पिक
Filter entries overlapping before this timestamp
time_off_typeenum or nullवैकल्पिक

Filter by type: location, staff, or asset

अनुमत मान:
resource_idstring or nullवैकल्पिक

Filter by associated resource ID (staff/asset)

location_idstring or nullवैकल्पिक
Filter by location ID

रिस्पॉन्स

सफल रिस्पॉन्स

namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
अनुमत मान:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumवैकल्पिकडिफ़ॉल्ट: closed
अनुमत मान:
override_hourslist of objects or nullवैकल्पिक

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullवैकल्पिक
location_idstring or nullवैकल्पिक

For LOCATION type: the location this closure applies to.

reasonstring or nullवैकल्पिक

त्रुटियाँ

422
Unprocessable Entity Error