Description
Returns the location object with the specified hierarchical location code.
Parameters
Name | Description |
---|---|
code |
Location: query Type: string The hierarchical location code consists of a set of 1 to 3 alpha-numeric strings separated by a space. The first two characters indicate a country, followed by next three characters which indicate a city in UN/LOCODE. New custom locations created under a UN/LOCODE city are appended to the end of the hierarchy. For example, CA TOR OF1 indicates:
Note: The code is case-sensitive. It must be all UPPER CASE
letters.
The county code and child location code should be alphanumeric strings. |
Responses
Code | Description |
---|---|
200 |
Type: APIEntity Returns the entity that matches the specified hierarchical location code. If no entity is found, returns an empty APIEntity. |