Booking_Policy config

Written By Natalia Povrozniak (Administrator)

Updated at July 10th, 2024

Booking_Policy config is the representation of what is set in a booking policy in Admin Portal. Read more about the concept of each setting here: Understanding Booking Policies: Guidelines for Efficient Space Bookings and Usage.

Parameter				Value type	Notes
ID				string
ETag
Node_Id				integer	Building or floor node ID
Booking_Policy_Id				string	Booking Policy ID
Booking_Policy_Name				string	Name of the booking policy
Booking_Policy				string (JSON object)
	Booking_Policy_Description			string	Description of the policy
	BookingSlots			string (JSON object)
		BookableTime		string (JSON object)	If the BookableTime element is missing or empty, no bookable times will be available.
			Days	list of strings	Accepted are values 1-7 for the selected days, where: "1" = Monday "2" = Tuesday "3" = Wednesday "4" = Thursday "5" = Friday "6" = Saturday "7" = Sunday
			StartTime	string	No min or default
			EndTime	string	No min or default
		ExcludedDates		string	List of dates and times that prevent the spaces from booking
		BookingStart		string (JSON object)	If both SpecificMinutes and SpecificTimes are present and have valid values, the values in SpecificMinutes will be used.
			SpecificMinutes	list of strings	Repeating start interval in minutes
			SpecificTimes	list of strings	Specific start interval times
		BookingEnd		string (JSON object)
			SpecificMinutes	list of strings	Repeating end interval
			SpecificTimes	list of strings	Specific end interval
		BookingSetupTime		integer	Default for both is 0. No Min/Max values.
		BookingTearDownTime		integer	Default for both is 0. No Min/Max values.
		BookingDuration		string (JSON object)
			Minimum	integer	Minimum booking duration
			Maximum	integer	Maximum booking duration
			Fixed	list of strings	Fixed time limits. If there is at least one valid value in the Fixed array, the values from the Fixed array are used, even if Minimum or Maximum are specified as well.
		BookingHorizon		string (JSON object)	If this is empty, meetings can booked for any time between now and 1 year from now.
			Minimum	integer	Minimum booking horizon
			Maximum	integer	Maximum booking horizon
			BookingOffset		Booking offset
		BookingRecurrence		string (JSON object)
			Maximum	integer	Maximum number of reoccurrences that can be booked. Maximum value is set to 52, minimum is 1.
			Allowed		True or false
	ArrivalPolicies			string (JSON object)
		AutoCheckin			True or false. When a user is booking on behalf of someone else and selects the Do you want to auto check in this employee (if they do not have access to Roamer) checkbox, this Booking_AutoCheckIn setting will precede over the AutoCheckin booking policy setting.
		EarlyCheckin		integer	If users are not checked in automatically, they may be allowed to check in early in this many minutes in advance if the space is free.
		AutoCancellation		integer	Booking is auto cancelled after this many minutes if not checked in.
	ApprovalPolicies			string (JSON object)
		ApprovalRequired			True or false
		AutoRejectionAfter		integer	If the booking is not approved, it is automatically rejected after this many days.
		ApprovalGroups			List of roles who can approve bookings of the associated spaces. If ApprovalRequired is set to true and ApprovalGroups is missing or empty, the bookings cannot be approved.
	ExtendedServices			string (JSON object)
		SpaceSetupManagement		string (JSON object)
			ManagementType		User
			User		Email of the responsible user
			Group
		CateringManagement		string (JSON object)
			ManagementType		User
			User		Email of the responsible user
			Group

Example of a record

{
"ID": 22817775,
"ETag": "",
"Node_Id": 6,
"Booking_Policy_Id": "7076dc0d-22c3-45da-b014-b1b5791a1979",
"Booking_Policy_Name": "Simple Desk Policy",
"Booking_Policy": {
"Booking_Policy_Description": "Desks are available to book up to 14 days in advance, Monday - Friday, between 00:00 and 23:59 for a minimum time of 60 minutes and no maximum booking time. On the day, if free, you will be able to check in 15 minutes early. If you fail to check in within 10 minutes of the booking start time, the booking will auto-cancel.",
"BookingSlots": {
"BookableTime": [
{
"Days": [
"1",
"2",
"3",
"4",
"5"
],
"StartTime": "07:00",
"EndTime": "23:59"
}
],
"ExcludedDates": [

],
"BookingStart": {
"SpecificMinutes": [

],
"SpecificTimes": [

]
},
"BookingEnd": {
"SpecificMinutes": [

],
"SpecificTimes": [

]
},
"BookingSetupTime": 0,
"BookingTearDownTime": 0,
"BookingDuration": {
"Minimum": 60,
"Maximum": 1440,
"Fixed": [

]
},
"BookingHorizon": {
"Minimum": 0,
"Maximum": 90,
"BookingOffset": ""
},
"BookingRecurrence": {
"Maximum": 1,
"Allowed": false
}
},
"ArrivalPolicies": {
"AutoCheckin": false,
"EarlyCheckin": 15,
"AutoCancellation": 10
},
"ApprovalPolicies": {
"ApprovalRequired": false,
"AutoRejectionAfter": 0,
"ApprovalGroups": [

]
},
"ExtendedServices": {
"SpaceSetupManagement": {
"ManagementType": "user",
"User": [
"Hassan.Ali@iconics-uk.com"
],
"Group": [

]
},
"CateringManagement": {
"ManagementType": "user",
"User": [

],
"Group": [

]
}
}
}
}

Example of a record

Related Articles