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

Get Location

Get a single location by ID.

पाथ पैरामीटर

location_idstringआवश्यक

हेडर

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

रिस्पॉन्स

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

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activebooleanकेवल-पढ़ने योग्य
addressstringवैकल्पिक
Street address.
notesstringवैकल्पिक
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectवैकल्पिक
customer_facing_namestringवैकल्पिक

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerवैकल्पिक1-999डिफ़ॉल्ट: 1

Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on.

deactivated_at_unixinteger or nullवैकल्पिक
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullवैकल्पिक
Why this location was deactivated. None when active.
अनुमत मान:

त्रुटियाँ

422
Unprocessable Entity Error