• Venue and event management in the cloud

How Can We Help?


Venues: Search Venue Bookings

In this article


Search Venue Bookings

POST /v2/venue/get/booking

Returns a list of venue bookings matching the search parameters provided in your request. The page size is 50 by default.

Parameter
StateDate    DateTime

The start date and time range of the venue bookings to be searched.

EndDate    DateTime

The end date and time range of the venuebookings to be searched.

NextPageDirection    String

What direction you would like to page for your next set of results. The only values allowed are UP or DOWN.

LastPageVenueId    Integer

The booking ID of the last venue on your current set of results to be used as the reference point for your next set of results.

Venue ID    Array (long)

The ID(s) of the venues you would like to search for bookings.

IncludeSetupSetdown     Boolean

trueto return setup or set down bookings in your results.
false to not return setup or set down bookings in your results.

 

{   
"StartDate" : "01/11/2018 09:00",
     "EndDate" : "30/11/2018 17:00",
     "NextPageDirection" : "forward",
     "LastPageVenueId" : 0,
     "OnlyAvailable" : true,
"OnlyReserved" : false }

Response:

List of venue bookings satisfying the search criteria.

{
"success" :true,
"result": [ {
          "BookingId": 5678,
          "BookingType":
{
   "ID": 6,
         "Name": "Meeting Room",
 },  "BookingComment": "The room comes with TV and HDMI cable.",
 "StartDate": "15/11/2018 12:00",

 "EndDate": "15/11/2018 16:00" "BookingStatus": { "Id":1,
       "Name": "Confirmed"
},  "EventNumber": 1234,
"BookingPax": 10,
"EventStatus": {          "Id":3,
          "Name": "Confirmed"
}, "VenueId": 123,
"VenueName": "Boardroom"
"EventType": { "Id":3,
          "Name": "Meeting"
},   "IsSetUp": false,
 "IsSetDown": false,
 "AssociatedBookingId": 0
    }
  ] }