Venues: Search Venues

Updated June 14, 2023 16:11

Search Venues

POST /v2/venue/get

Returns a list of venues matching the search parameters provided in your request. By default, only the first 50 searched venues will be returned.

Parameter

StartDate DateTime

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

EndDate DateTime

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

NextPageDirection String

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

LastPageVenueId Long

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

OnlyAvailable Boolean

true if you would like to search for venues that are available to be booked.
false to not restrict the search by availability.

OnlyReserved Boolean

true if you would like to search for venues that are already booked.
false to not restrict the search by reserved venues.

PageNo Integer

The Page Number of the Venue list results.

Offset Integer

If Offset is specified then it will fetch the next number of records after offset and skip the previous records, for e.g If there are 50 records and offset is 10 then records will be fetched from 11 to 50.

RecordsPerPage Integer

The number of records per page.

SortingOrder Object Array

The sorting of data as per the ColoumnName provided. If IsAscending is true, sorts the result in the ascending order else in the descending order.

NOTE: Sorting order cannot be passed along with NextPageDirection and LastPageVenueId

JSON

{
    "StartDate": "01/07/2018 15:30:00",
    "EndDate": "01/08/2018 15:30:00",
    "OnlyAvailable": "false",
    "OnlyReserved": "false",
    "NextPageDirection": "Forward",
    "LastPageVenueId": 18963,
    "PageNo": "1",
    "Offset": "0",
    "RecordsPerPage": "10",
    "SortingOrder": [
        {
            "ColumnName": "VenueName",
            "IsAscending": true
        }
    ]
}

Response:

List of venues satisfying the search criteria.

{
  "success": true,
  "result": [{
     "ParentGroupName": "Corporate ",
     "Position": 2,
     "VenueName": "UWA Watersports",
     "ParentGroupId": 5584,
     "Inactive": false,
     "VenueId": 18962,
     "MinCapacity": 75,
     "MaxCapacity": 150,
     "Address": {
       "MapAddress": "79 Peninsula Road, Kawarau Village, Queenstown 9300, New Zealand",
       "MapUrl": "https://maps.google.com/?cid=11190120416688158724",
       "Suburb": "Queenstown",
       "Latitude": "-45.02880030000001",
       "Postcode": "9300",
       "Longitude": "168.7283827",
       "AddressLine3": "",
       "AddressLine2": "Kawarau Village",
       "AddressLine1": "79 Peninsula Road",
       "State": "Otago",
       "isPrimary": true,
       "Country": "New Zealand",
       "AddressType": "BUSINESS"
     },
     "Images": [{
      "Position": 1,
      "FileType": "Image File",
      "AlternateText": "June24 1",
      "TicketingOrderNo": "",
      "Id": 2039,
      "URL": "https://apse2-priava-dev.s3.ap-southeast-2.amazonaws.com/IMAGE/CATALOGUE/Venue/4/100358391/catlImg_1.jpg",
      "Name": "catlImg_1.jpg",
      "FileSize": 12217
     },{
      "Position": 2,
      "FileType": "Image File",
      "AlternateText": "June24 2",
      "TicketingOrderNo": "",
      "Id": 2040,
      "URL": "https://apse2-priava-dev.s3.ap-southeast-2.amazonaws.com/IMAGE/CATALOGUE/Venue/4/100358391/catlImg_2.jpg",
      "Name": "catlImg_2.jpg",
      "FileSize": 14925
     }]
   },{
     "ParentGroupName": "Corporate ",
     "Position": 3,
     "VenueName": "Allendale Square Conference Suite",
     "ParentGroupId": 5584,
     "Inactive": false,
     "VenueId": 18961,
     "MinCapacity": 0,
     "MaxCapacity": 0
   },{
     "ParentGroupName": "Event Venues ",
     "Position": 1,
     "VenueName": "Supreme Court Gardens",
     "ParentGroupId": 5585,
     "Inactive": false,
     "VenueId": 18964,
     "MinCapacity": 500,
     "MaxCapacity": 5000
   },{
     "ParentGroupName": "Event Venues ",
     "Position": 2,
     "VenueName": "Quarry Ampitheatre",
     "ParentGroupId": 5585,
     "Inactive": false,
     "VenueId": 18960,
     "MinCapacity": 140,
     "MaxCapacity": 700
   }]
}

Was this article helpful?

Have more questions? Submit a request