Add or Update Booking Session

Add or Update Booking Session

POST [PlatformAddress]/api/1.0/venue?action=addOrUpdateBookingSession

Adds or updates the details of a venue booking session. NOTE: The venue must have access to add or update booking session in order to call this api action.

200

{
  "success": true,
  "id": 8821,
  "warnings": null
}

200

200

Booking Session

Property	Type	Required	Description
id	integer	optional	The unique id of the booking session to update. A new booking session will be created if this parameter is not present.
spaceVenueId	integer	required	The id of the venue to which the booking session belongs.
bookingId	integer	required	The id of the booking to which the new booking session will be assigned.
contactId	integer	required	The id of the booking to which the new booking session will be assigned.
name	string	required	The booking session name. Required when adding a new booking session.
minAttendeesGuaranteed	integer	optional	The total attendees of the booking session. Required when adding new booking session.
agreedAttendees	integer	optional	The agreed attendees of the booking session.
expectedAttendees	integer	optional	The expected attendees of the booking session.
guaranteedAttendees	integer	optional	The guaranteed attendees of the booking session.
setAttendees	integer	optional	The set attendees of the booking session.
actualAttendees	integer	optional	The actual attendees of the booking session.
spaceId	integer	optional	The id of the space to which the booking session belongs.
spaceLayout	integer	optional	The id of the space layout to which the booking session belongs.
layoutType	integer	optional	The type of the space layout to which the booking session belongs. (This key will only consider when you don't pass spaceLayout key in request data)
customLayoutName	string	optional	The name of custom space layout.
startDate	date	required	Start date of the sesion.
startTime	string	optional	The start time of the booking session. Format is HH:mm:ss
endTime	string	optional	The end time of the booking session. Format is HH:mm:ss
setupTime	integer	optional	The setup time (in mins) of the booking session.
setdownTime	integer	optional	The setdown time (in mins) of the booking session
includeInPackage	boolean	optional	Whether or not the booking session is included in booking package.
bookingPackageId	integer	optional	The id of the booking package to which the booking session belongs. Required when includeInPackage is true
tariffId	integer	optional	The tariff id to which the booking session belongs. Required when includeInPackage is true
roomHireType	integer	optional	The room hire type to which the booking session belongs. Required when includeInPackage is true
costcenterId	integer	optional	The id of the cost center to which the booking session belongs. Required when adding new booking session
cost	double	optional	The price of the booking session. Required when includeInPackage is false
excludedTaxIds	array	optional	The array of tax Ids which are excluded to apply on the booking session. Required when includeInPackage is false
sessionTypeId	integer	optional	The session type id to which the session belogns
overridePax	bool	optional	Whether or not to over ride max pax of the space
isSignageVisible	bool	optional	isSignageVisible
signage	string	optional	Signage of the booking session

Example Request

{
  "venueId": 1,
  "bookingId": 15722,
  "spaceVenueId": 1,
  "name": "test",
  "contactId": 10,
  "minAttendeesGuaranteed": 10,
  "spaceId": 3,
  "spaceLayout": 0,
  "customLayoutName": "test",
  "startDate": "2020-10-28",
  "startTime": "10:00:00",
  "endTime": "11:00:00",
  "setupTime": "60",
  "setdownTime": "60",
  "includeInPackage": 0,
  "bookingPackageId": 2018,
  "tariffId": "1",
  "roomHireType": "1",
  "costcenterId": "4",
  "cost": "400",
  "excludedTaxIds": []
}

Returns

Property	Description
success	Whether or not the session is added/updated to the booking
id	The unique id of the Booking Session

Throws

Code	Description
Specific Code: 24360	The booking does not exist
Specific Code: 24361	The session does not exist
Specific Code: 24362	An error has occurred
Specific Code: 24363	The request contains invalid data
Specific Code: 24364	The request contains invalid data