Geographies
Entry Point: /geographies/{scope}/countries
The geographies resource family provides access to location related data, including lists of countries, and lists of regions by country.
Read Countries
Retrieve a list of countries available to a scope.
Workflow
- Start with root
GETthe link with rel: countries- Render the response
Read Country
Read a single country.
Workflow
- Start with countries
GETthe link with rel: element- Render the response
Response Fields
Type: geographies.country
| Name | Description | Type |
|---|---|---|
name | The name or code of the country. | string |
display-name | The localized country name, intended for display in the client application. | string |
Read Region
Read a single region in a country.
Workflow
- Start with country
GETthe link with rel: regionsGETthe link with rel: element- Render the response
Response Fields
Type: geographies.region
| Name | Description | Type |
|---|---|---|
name | The name or code of the region. | string |
display-name | The localized region name, intended for display in the client application. | string |