Latest revision as of 12:59, 20 February 2013

[edit] GET /countries/{countryCode}/provinces

Get list of provinces for a given country.

[edit] Request

GET /countries/{countryCode}/provinces

[edit] Request Parameters

countryCode - string

The 3166-1 alpha-2 country code (e.g. US, CA, UK, DE, AU).

[edit] URI Parameters

None.

[edit] Response

[edit] Status Code

200 OK

Success

404 Not Found

Returned if countryCode is not found or provinces are not defined for the given country.

[edit] Response Body

{
  "list": [
    {
      "code": "AL",
      "name": "Alabama"
    },
    {
      "code": "AK",
      "name": "Alaska"
    },	
...
...
    {
      "code": "WI",
      "name": "Wisconsin"
    },
    {
      "code": "WY",
      "name": "Wyoming"
    }
  ],
  "links": [
    "self": {"href": "https://api.hostway.com/countries/US/provinces", "rel": "self"}
  ]
}
 

[edit] Parameters

code - string

The state/province code (e.g. NJ, IL, DC, CA, FL).

name - string

The full state/province name.

links - list

Hypermedia for this resource. Links to self.

[edit] See also

• Miscellaneous APIs
• Common Features