Get a location for an organization
GET api/V3/{language}/org/{orgIdentifier}/locations/{id}
You can get the location id from /org/{orgIdentifier}/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 |
orgIdentifier (string) |
Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'. |
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 |