Venues: Search Venues and Groups

Updated June 14, 2023 15:56

Search Venues and Groups

POST /v2/venue/get/groups

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

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.

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, I f you would like to search for venues that are already booked.
false, To not restrict the search by reserved venues.

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.

IncludeEmptyGroups Boolean

true if you want to include empty venue groups too, false otherwise.

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.

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

JSON

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

Response:

List of venues in tree structure satisfying the search criteria.

{
   "success": true,
   "result": [{
         "Position": 1,
         "VenueName": "NewMainVenueGroup",
         "Items": [{
               "Position": 1,
               "VenueName": "MainVenue4",
               "VenueId": 100321578,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 2,
               "VenueName": "MainVenue3",
               "VenueId": 100321577,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 3,
               "VenueName": "MainVenue2",
               "VenueId": 100314065,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 4,
               "VenueName": "MainVenue1",
               "VenueId": 100314064,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 1,
               "VenueName": "NewSubVenueGroup",
               "Items": [{
                     "Position": 1,
                     "VenueName": "Subitem2",
                     "VenueId": 100314063,
                     "MinCapacity": 0,
                     "MaxCapacity": 0
                  },
                  {
                     "Position": 2,
                     "VenueName": "Subitem1",
                     "VenueId": 100314062,
                     "MinCapacity": 0,
                     "MaxCapacity": 0
                  }
               ],
               "VenueId": 100080655
            }
         ],
         "VenueId": 100080654
      },
      {
         "Position": 2,
         "VenueName": "TestNew1234",
         "Items": [{
            "Position": 1,
            "VenueName": "Course1",
            "VenueId": 100303899,
            "MinCapacity": 0,
            "MaxCapacity": 0
         }],
         "VenueId": 100078086
      },
      {
         "Position": 3,
         "VenueName": "NewVensGroup",
         "Items": [{
            "Position": 1,
            "VenueName": "CourseGrid",
            "VenueId": 100301605,
            "MinCapacity": 0,
            "MaxCapacity": 0
         }],
         "VenueId": 100077475
      },
      {
         "Position": 6,
         "VenueName": "NewVenueCatalogue",
         "Items": [{
               "Position": 1,
               "VenueName": "TestVName",
               "VenueId": 100262663,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 2,
               "VenueName": "VTest2",
               "VenueId": 100253350,
               "MinCapacity": 0,
               "MaxCapacity": 0
            },
            {
               "Position": 4,
               "VenueName": "NewVenueitem",
               "VenueId": 100248288,
               "MinCapacity": 10,
               "MaxCapacity": 20
            }
         ],
         "VenueId": 100063951
      }
   ]
}

Was this article helpful?

Have more questions? Submit a request