• Venue and event management in the cloud

How Can We Help?


Venues: Search Venues

In this article


Search

POST /v2/venue/get

Returns a list of venues 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 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    Integer

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.

 

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

Response:

List of venues satisfying the search criteria.

{

  "success" : true,
    "result" :
     [
   "VenueId": 123,
          "MaxCapacity": 25,
         "MinCapacity": 0,
         "VenueName": "Boardroom",
         "ParentGroupId": 1,
         "ParentGroupName": "Boardrooms",
         "Position": 3
     },
     {
         "VenueId": 847,
          "MaxCapacity": 10,
          "MinCapacity": 0,
          "VenueName": "Meeting Room 12",
         "ParentGroupId": 2,
         "ParentGroupName": "Meeting Spaces",
         "Position": 12
            } ]
}