Countries-countryCode-provinces:GET
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision) |
Mike.robski (Talk | contribs) m (1 revision) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
==== Request Parameters ==== | ==== Request Parameters ==== | ||
; countryCode - ''string'' | ; countryCode - ''string'' | ||
| − | : The country code | + | : The [http://www.iso.org/iso/iso-3166-1_decoding_table.html|ISO 3166-1 alpha-2] country code (e.g. ''US'', ''CA'', ''UK'', ''DE'', ''AU''). |
=== URI Parameters === | === URI Parameters === | ||
| Line 20: | Line 20: | ||
;404 Not Found | ;404 Not Found | ||
| − | : Returned if countryCode is not found or provinces are not defined for the given country. | + | : Returned if ''countryCode'' is not found or provinces are not defined for the given country. |
=== Response Body === | === Response Body === | ||
| Line 27: | Line 27: | ||
"list": [ | "list": [ | ||
{ | { | ||
| − | " | + | "code": "AL", |
"name": "Alabama" | "name": "Alabama" | ||
}, | }, | ||
{ | { | ||
| − | " | + | "code": "AK", |
"name": "Alaska" | "name": "Alaska" | ||
}, | }, | ||
| Line 37: | Line 37: | ||
... | ... | ||
{ | { | ||
| − | " | + | "code": "WI", |
"name": "Wisconsin" | "name": "Wisconsin" | ||
}, | }, | ||
{ | { | ||
| − | " | + | "code": "WY", |
"name": "Wyoming" | "name": "Wyoming" | ||
} | } | ||
], | ], | ||
"links": [ | "links": [ | ||
| − | "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces | + | "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces", "rel": "self"} |
] | ] | ||
} | } | ||
| Line 52: | Line 52: | ||
=== Parameters === | === Parameters === | ||
| − | ; | + | ; code - ''string'' |
| − | : The state/province code | + | : The state/province code (e.g. ''NJ'', ''IL'', ''DC'', ''CA'', ''FL''). |
; name - ''string'' | ; name - ''string'' | ||
| − | : | + | : The full state/province name. |
; links - ''list'' | ; links - ''list'' | ||
Latest revision as of 12:59, 20 February 2013
[edit] GET /countries/{countryCode}/provinces
Get list of provinces for a given country.
Contents |
[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
