Venues: Search Venue Bookings

Updated June 14, 2023 16:11

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 venue bookings to be searched.

VenueGroupSearch Boolean

true if you want to filter out results with specified VenueGroupId or BookingId, false otherwise.

VenueGroupId Long

If specified, the results will be filtered to return results for venues present under specified VenueGroupId only.

BookingId Long

If specified, the results will be filtered to return results for specified Booking Id only.

Note: If both VenueGroupId and BookingId are specified, then VenueGroupId will have precedence over BookingId.

IncludeSpecialDays Boolean

true to include special day as venue bookings in your result, false otherwise.

NextPageDirection String

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

LastPageBookingId Long

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

VenueId Array(long)

If specified, the results will be filtered to return bookings booked for specified venue ids only.

IncludeSetupSetdown Boolean

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

OnlyReserved Boolean

true if you would like to search for reserved bookings.
false to not restrict the search by reserved bookings.

JSON

{
   "StartDate": "06/05/2018 09:00",
   "EndDate": "27/05/2018 19:00",
   "VenueId": [
      15083
   ],
   "IncludeSetupSetdown": false,
   "OnlyReserved": true,
   "NextPageDirection": "forward",
   "LastPageBookingId": "",
   "VenueGroupSearch": true,
   "VenueGroupId": "4495",
   "BookingId": "103433133",
   "IncludeSpecialDays": false
}

Response:

List of venue bookings satisfying the search criteria.

{
   "success": true,
   "result": [{
         "Abbreviation": "VB",
         "EventType": {
            "Id": 100021200,
            "Name": "Awards Dinner"
         },
         "VenueName": "Running Track",
         "EventStatus": {
            "Type": "Reserved",
            "Id": 100012742,
            "Name": "Ereserved"
         },
         "AssociatedBookingId": 0,
         "EventName": "SampleOpppsa",
         "EndDate": "24/05/2018 17:30",
         "BookingPax": 15,
         "Name": "Running Track",
         "StartDate": "24/05/2018 09:00",
         "EventNumber": "2049",
         "IsSetUp": false,
         "IsSetDown": false,
         "Qty": 15,
         "BookingId": 103433873,
         "BookingStatus": {
            "Type": "Reserved",
            "Color": "#009900",
            "Id": 100009576,
            "Name": "Course Confirmed"
         },
         "VenueId": 15083,
         "BookingType": {
            "Id": 5550,
            "Name": "Performance"
         },
         "BookingComment": ""
      },
      {
         "Abbreviation": "VB",
         "EventType": {
            "Id": 2100,
            "Name": "Government"
         },
         "VenueName": "Running Track",
         "EventStatus": {
            "Type": "Reserved",
            "Id": 100012742,
            "Name": "Ereserved"
         },
         "AssociatedBookingId": 0,
         "EventName": "testing repeat event",
         "EndDate": "18/05/2018 17:30",
         "BookingPax": 15,
         "Name": "Running Track",
         "StartDate": "18/05/2018 09:00",
         "EventNumber": "2046",
         "IsSetUp": false,
         "IsSetDown": false,
         "Qty": 15,
         "BookingId": 103942330,
         "BookingStatus": {
            "Type": "Reserved",
            "Color": "#00ffff",
            "Id": 100012742,
            "Name": "Ereserved"
         },
         "VenueId": 15083,
         "BookingType": {
            "Id": 5549,
            "Name": "Instrument Delivery"
         },
         "BookingComment": ""
      }
   ]
}

Was this article helpful?

Have more questions? Submit a request