1. Knowledge Base
  2. API & Integrations
  3. SDK Reference (Version 2)

Venues: Get Venues List

  • Updated

GetVenuesList

GetVenues

POST /v2/common/catl/get

Returns a list of venues matching the search parameters provided in your request. 

Parameter
CatalogueTypeName    String

The catalogue type name. For example, Venue.

IncludeInactive    Boolean

true   if you would like to include inactive catalogue items as well,  false  otherwise.

LastUpdatedDate    DateTime

Filter out the catalogue items that have been updated after the last updated date provided.

CreatedDate    DateTime

Filter out the catalogue items that have been created after the last created date provided.

{

    "CatalogueTypeName": "Venue",
    "IncludeInactive": true,
    "LastUpdatedDate": "16/09/2020 01:00:00",
    "CreatedDate": "16/09/2020 01:00:00"

}

Response:

List of venues satisfying the search criteria.

{
    "result": {
        "result": [
            {
                "ParentGroupName": "Jp Resorts",
                "Address": "",
                "Position": -1,
                "UpdatedDate": "17/09/2020 02:23",
                "VenueName": "Jp Banquets",
                "Images": [],
                "ParentGroupId": 100107313,
                "MinCapacity": 0,
                "IsGroup": false,
                "CreatedDate": "16/09/2020 19:11",
                "Inactive": false,
                "VenueId": 100416859,
                "MaxCapacity": 0
            },
            {
                "ParentGroupName": "D-mart Resorts",
                "Address": {
                    "MapAddress": "",
                    "MapUrl": "",
                    "Suburb": "",
                    "Latitude": "",
                    "Postcode": "",
                    "Longitude": "",
                    "AddressLine3": "",
                    "AddressLine2": "",
                    "AddressLine1": "",
                    "State": "",
                    "isPrimary": true,
                    "Country": "",
                    "AddressType": "BUSINESS"
                }
            }
        ]
    },
    "success": true
}

 

Was this article helpful?

Have more questions? Submit a request