AreaReference
Object: AreaReference
Section titled “Object: AreaReference”A logical area, within an organisation.
Organisations are subdivided into areas and spaces. Spaces can be assigned to areas, from whence they can be booked against. Areas are the level at which rulesets are defined and applied.
An area reference contains a subset of the properties on an area.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id* | UUID! | The ID of the area. |
name* | String! | The name of the area. |
description | String | The description of the area. |
instructions | String | A set of instructions, to be displayed with a booking. |
icon | Icon | The icon for this area. Mutually exclusive with logo |
logo | Image | The logo for this area. Mutually exclusive with Icon |
displayPin* | Boolean! | Whether a booking's PIN code should be displayed on the booking. A booking's PIN code is a semi-unique code that is unique within 72 hours before or after the booking. |
address | PhysicalAddress | optional address information |
yardEnabled* | Boolean! | A flag indicating whether the area is treated as a yard. |