Get a location

GET api/V3/{language}/locations/{id}

You can get the location id from /locations.

Request Information

URI Parameters

PARAMETERS
language (string)	Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'	Required
id (integer)	Location id	Required

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
FullName (string)	First and last name with a space in between
Description (string)	Description of the activity that will be visible to your customers in your store
Telephone (string)	Telephone number
TelephoneExtension (string)	Telephone number extension
ParentId (integer)	Id of the location immediately above the location in the hierarchy
TopParentId (integer)	Top parent location id
AncestorIds ()	Ids of all the locations above the location in the hierarchy, at all parent levels
Keywords ()	Object containing the id and name of keywords, which are specific types of activities, such as 'soccer' or 'yoga'
Address (GeoAddressApiModelV3)	Object containing the address (door number, street name, city, state/province, country, zip/postal code, latitude and longitude)
Id (integer)	Resource id
Name (string)	Resource name

Response Formats

CODE SAMPLE JSON

{
  "FullName": "Natatorium de Verdun",
  "Description": "Piscines profonde et moyenne, pataugeoire",
  "Telephone": "514 555 1111",
  "TelephoneExtension": "324",
  "ParentId": 5432,
  "TopParentId": 33,
  "AncestorIds": [
    5432,
    6852,
    33
  ],
  "Keywords": [
    {
      "Id": 34,
      "Name": "Swimming"
    },
    {
      "Id": 41,
      "Name": "Rescue"
    }
  ],
  "Address": {
    "Latitude": 45.72,
    "Longitude": -73.5,
    "Address1": "9000 boul. Lasalle",
    "Address2": "",
    "City": "Montreal",
    "Country": "Canada",
    "StateProvince": "QC",
    "ZipPostalCode": "H4E 1P4"
  },
  "Id": 0,
  "Name": "Natatorium"
}