Resource Calendar for Bookings - API Reference

Resource Calendar for Bookings

Bookings need to be made against a calendar. A resource might be a staff member, a room, a seat, or a hire item.

End Point URL

https://api.cms-tool.net/webapps/api/bookingresource

API Parameters and Filters

Name	Description	Example	Data Type
id	If ID is specified, then only a single element is returned if found. Otherwise, an array is returned, even if only one item matches.	id=12345	int
resourcename	The name of the resource.	resourcename="Andrew"	string
resourceemail	Email address of the resource if applicable.	resourceemail="name@example.com"	string
pid	The product Id, which can be hired or booked. Use the /product endpoint to get complete information about products.	pid=123	int
resourceType	The resourceType. Valid options are HireItem, Accommodation, Person, Seat.	resourceType="HireItem"	string

Data Dictionary

Key	Definition	Type	Format
availablefrom	Available From Bookings available from, eg when this resource becomes available, starts, back from holiday etc.	date	e.g. 2025-12-31
availableuntil	Available Until Bookings not allowed after this date, employee termination date?	date	e.g. 2025-12-31
calsync_api	Sync api Currently only supports value: GOOGLE_CALENDAR	text
calsync_calendar_id	Sync calendar id The GUID of the external calendar to sync with	text
calsynclast	Sync last Timestamp of last sync	timestamp	e.g. 2025-12-31 23:59:59
calsync_last_output	Sync last output Last output from the sync process for debug purposes	text
calsync_token	Sync oAuth token oAuth token credential	text
cid	Website ID Website ID	int	e.g. 123456
fri_finish	Timetable fri finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
fri_start	Timetable fri start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
max_booking_duration	max booking duration Max booking duration if different to global settings	interval	e.g. 01:00:00
max_booking_notice	max booking notice Max booking notice (prior to booking) if different to global settings	interval	e.g. 01:00:00
min_booking_duration	min booking duration Minimum booking duration if different to global settings	interval	e.g. 01:00:00
min_booking_notice	min booking notice Minimum booking notice (prior to booking) if different to global settings	interval	e.g. 01:00:00
mon_finish	Timetable mon finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
mon_start	Timetable mon start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
pid	Product ID For hire items, each unique item had it's own calendar, and this ID links them to the product for hire	int
resourceemail	resourceemail Email to send bookings to	text
resourceid	ID Unique ID for each calendar, system generated integer ID	Integer (Unique ID)	e.g. 123456
resourcename	Name Name of calendar, eg staff name, or room number	text
resourcetags	Tags Tags to help associate staff that match service offerings.. eg which staff has which skills.	text
resourcetype	Type Limited to: HireItem, Accommodation, Person, Seat	text
resource_uid	User ID Staff User ID associated with this calendar. Not all calenders have a user ID	int
sat_finish	Timetable sat finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
sat_start	Timetable sat start Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
staff_booking_spacing	Booking spacing the preferred interval between bookings for a rest/tidy/clean etc.	interval	e.g. 01:00:00
sun_finish	Timetable sun finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
sun_start	Timetable sun start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
thu_finish	Timetable thu finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
thu_start	Timetable thu start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
tue_finish	Timetable tue finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
tue_start	Timetable tue start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
wed_finish	Timetable wed finish Finish time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59
wed_start	Timetable wed start Start time for this resource if different to the business global timetable	time	Precision: 15.6 e.g. 23:59:59

Usage Instructions and Examples

Add a new resource

You do not need to provide the id if you want to add a new resource. The rest of the information will be used to create the new resource.

Example

"calendar_increment": "01:00:00",

"min_booking_duration": "00:05:00",

"max_booking_duration": "01:00:00",

"resourcename": "Test"

Update a resouce

Please provide the id of the resource you wish to update. Only provide the information you wish to update.

"id": 123,

"resourcename": "Test",

"max_booking_duration": "01:00:00"

Sample Object


{"sat_start":"09:00:00",
"calendar_increment":"00:30:00",
"min_booking_notice":"00:30:00",
"wed_start":"09:00:00",
"min_booking_duration":"02:00:00",
"pid":0,
"mon_finish":"17:00:00",
"max_booking_notice":"11 mons",
"wed_finish":"17:00:00",
"tue_start":"09:00:00",
"sun_start":"09:00:00",
"max_booking_duration":"02:00:00",
"sun_finish":"17:00:00",
"id":2368,
"fri_start":"09:00:00",
"sat_finish":"17:00:00",
"resourceid":2368,
"fri_finish":"17:00:00",
"thu_finish":"17:00:00",
"resourcetype":"Person",
"tue_finish":"17:00:00",
"mon_start":"09:00:00",
"thu_start":"09:00:00",
"resourcename":"Test Name",
"cid":1111
}