Follow

List External Venues

Returns a list of venues which exist for a given organisation and system type. This is used where the master source of venues is a 3rd party API and an import tool needs a list of venues which have been created by the import. Technically an External Venue is a combination of a 'Venue' and a 'CrossReference_Venue'. The ID of the venue is ignored and replaced with the external ID from the cross reference record.

 

Attributes 

Attribute

Value

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        500 - Internal Server Error

Path

/v3/organisations/{organisationID}/externalVenues

HTTP Method

GET

Support Formats

JSON, XML

Rate Limited

No

Cache Timeout

TBC

Secure

Yes

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

GET /v3/organisations/123/externalVenues?systemType=10 HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Param 

?systemType=(SystemType)

 

 Notes:

  1. The system type is a numeric value to identify the external system. e.g. Facebook may equal 1, Twitter = 2, etc.

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service.

Type

Value

Header

HTTP/1.1 200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

[

   {

      "id":"1004",

      "systemType":null,

      "venueTypeCode":"PHYSICAL",

      "name":"Voorburg",

      "alternativeName":"",

      "addressLine1":"Kon. Julianalaan 267",

      "addressLine2":"VOORBURG",

      "addressLine3":"",

      "alternativeAddressLine1":"",

      "alternativeAddressLine2":"",

      "alternativeAddressLine3":"",

      "postCode":"2273 JG",

      "phone":"0703867501",

      "email":"1004@nl.mcd.com",

      "web":"http://www.mcdonaldsvoorburg.nl",

      "latitude":52.075318000,

      "longitude":4.359547000,

      "organisationId":575,

      "isHidden":false,

          "openHours": [

      {

         "day":"mon",

         "startTime":"08:00",

         "endTime":"18:00",

         "note":"Test Note"

      },

      {

         "day":"wed",

         "startTime":"08:00",

         "endTime":"20:00",

         "note":""

      }

          ],

          "features":[

       "Wi-Fi",

        "Parking"

           ],

          "extendedData" : null,

          "CountryId" : null

   },

   {

      "id":"1005",

      "systemType":null,

      "venueTypeCode":"PHYSICAL",

      "name":"Amsterdam Nieuwendijk 212",

      "alternativeName":"",

      "addressLine1":"Nieuwendijk 212",

      "addressLine2":"AMSTERDAM",

      "addressLine3":"",

      "alternativeAddressLine1":"",

      "alternativeAddressLine2":"",

      "alternativeAddressLine3":"",

      "postCode":"1012 MX",

      "phone":"0206238141",

      "email":"1005@nl.mcd.com",

      "web":"http://www.mcdonaldsnieuwendijk212.nl",

      "latitude":52.374025000,

      "longitude":4.892982000,

      "organisationId":575,

      "isHidden":false,

      "openHours": [],

      "features":[],

      "contentTagReferenceCodes": [],

      "extendedData" : null,

      "CountryId" : null

   }

]

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.