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
| Method | Path | Description |
|---|---|---|
GET | /reservation-service-resources | List service resources |
GET | /reservation-service-resources/:id | Get a service resource |
POST | /reservation-service-resources | Create a service resource |
PATCH | /reservation-service-resources/:id | Update a service resource |
DELETE | /reservation-service-resources/:id | Delete a service resource |
The service resource object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Owning organization. Required on create; must be the API key's organization. |
service_id | integer | Service. Required on create. |
resource_id | integer | Resource. Required on create. |
assignment_mode | string | How the resource is used on booking. Default required. See below. |
quantity_required | integer | Capacity units of the resource one reservation uses. Default 1, minimum 1. |
priority | integer | Default 0. Stored ordering value; not used by automatic assignment. |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the link is deleted. |
assignment_mode
| Value | Behavior when a reservation is created |
|---|---|
required | The resource must be within its weekly hours, not blocked that day, and have quantity_required free capacity, or the reservation is rejected. |
optional | Assigned when free; skipped otherwise. |
any_available | Any 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.