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

1. Start with root
2. GET the link with rel: countries
3. Render the response

Read Country

Read a single country.

Workflow

1. Start with countries
2. GET the link with rel: element
3. 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

1. Start with country
2. GET the link with rel: regions
3. GET the link with rel: element
4. 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