Get facility (location) by id
GET PublicApi/{rewriteUrl}/{language}/Facilities/{id}
You can get the facility id from /Facilities.
Request Information
URI Parameters
PARAMETERS | ||
---|---|---|
rewriteUrl (string) |
Unique, url-friendly organization token. Part of base url |
Required |
language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
id (integer) |
Facility id |
Required |
Body Parameters
None.
Response Information
Resource Description
PARAMETERS | ||
---|---|---|
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 |
|
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 |
|
State (State) |
For an activity, object containing the values Normal, Skipped, Moved, Cancelled, Archived and Replaced |
|
Id (integer) |
Resource id |
|
Name (string) |
Resource name |
|
Address (Address) |
Object containing the address (door number, street name, city, state/province, country, zip/postal code, latitude and longitude) |