Resource Object


A resource represents an entity, such as a room or a staff member, that can be scheduled for use in a booking (SDK | REST). The availability of a resource is tracked to ensure that it can be allocated at a requested time slot and to prevent double bookings.

Properties
idstringRead-onlyformat GUID

Resource ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the resource is updated. To prevent conflicting changes, the current revision must be passed when updating the resource.


createdDatestringRead-onlyformat date-time

Time in YYYY-MM-DDThh:mm:ss.sssZ format the resource was created.


updatedDatestringRead-onlyformat date-time

Time in YYYY-MM-DDThh:mm:ss.sssZ format the resource was last updated.


namestringmaxLength 40minLength 1

Name of the resource.


typeIdstringformat GUID

ID of the resource type (SDK | REST).

Once a type has been set it can't be modified. You can create a resource without specifying a type. However, customers can't book such resources.


workingHoursSchedulesWorkingHoursSchedules

Information about the schedule (SDK | REST) specifying the working hours and locations of the resource.

Resources without a working hour schedule are available 24/7 at the locations specified in the field locationOptions. When both workingHoursSchedules and locationOptions are set, workingHoursSchedules takes precedence.


locationOptionsLocationOptions

Information about the location where the resource is available.


eventsScheduleEventsScheduleRead-only

Schedule containing the events (SDK | REST) for which the resource has been booked.


extendedFieldsExtendedFields

Extensions enabling users to save custom data related to the resource.

Resource
JSON
Did this help?