Reservation service resources

A service resource links a resource to a service and says how it is used when someone books that service: whether it is required, optional or any resource of the same type, and how much of its capacity one booking takes. Services without links are bookable 08:00–18:00 without resource checks.

Endpoints

MethodPathDescription
GET/reservation-service-resourcesList service resources
GET/reservation-service-resources/:idGet a service resource
POST/reservation-service-resourcesCreate a service resource
PATCH/reservation-service-resources/:idUpdate a service resource
DELETE/reservation-service-resources/:idDelete a service resource

The service resource object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOwning organization. Required on create; must be the API key's organization.
service_idintegerService. Required on create.
resource_idintegerResource. Required on create.
assignment_modestringHow the resource is used on booking. Default required. See below.
quantity_requiredintegerCapacity units of the resource one reservation uses. Default 1, minimum 1.
priorityintegerDefault 0. Stored ordering value; not used by automatic assignment.
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the link is deleted.

assignment_mode

ValueBehavior when a reservation is created
requiredThe resource must be within its weekly hours, not blocked that day, and have quantity_required free capacity, or the reservation is rejected.
optionalAssigned when free; skipped otherwise.
any_availableAny active resource with the same resource_type that is free is assigned; the reservation is rejected when none is.

The weekly hours of every linked resource also define which slots the service offers.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.