Countries-countryCode-provinces:GET - Revision history

Mike.robski: 1 revision

2013-02-20T17:59:19Z

1 revision

Mike.robski at 17:55, 20 February 2013

2013-02-20T17:55:35Z

Mike.robski: 1 revision

2013-02-19T17:58:54Z

1 revision

Mike.robski at 17:57, 19 February 2013

2013-02-19T17:57:47Z

New page

= GET /countries/{countryCode}/provinces =
Get list of provinces for a given country.
__TOC__

== Request ==
<code>GET /countries/{countryCode}/provinces</code>

==== Request Parameters ====
; countryCode - ''string''
: The country code - ''e.g. US, CA, UK, DE, AU''

=== URI Parameters ===
None.

== Response ==

=== Status Code ===
;200 OK
: Success

;404 Not Found
: Returned if countryCode is not found or provinces are not defined for the given country.

=== Response Body ===
<nowiki>
{
"list": [
{
"isoCode": "AL",
"name": "Alabama"
},
{
"isoCode": "AK",
"name": "Alaska"
},
...
...
{
"isoCode": "WI",
"name": "Wisconsin"
},
{
"isoCode": "WY",
"name": "Wyoming"
}
],
"links": [
"self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces/", "rel": "self"}
]
}
</nowiki>

=== Parameters ===
; isoCode - ''string''
: The state/province code - ''e.g. NJ, IL, DC, CA, FL''

; name - ''string''
: Full state/province name

; links - ''list''
: [[Hypermedia]] for this resource. Links to self.

== See also ==
* [[Miscellaneous|Miscellaneous APIs]]
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Miscellaneous APIs]]

@@ Line 8: / Line 8: @@
 ==== Request Parameters ====
 ; countryCode - ''string''
-: The country code - ''e.g. US, CA, UK, DE, AU''
+: 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 ===
@@ Line 20: / Line 20: @@
 ;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 ===
@@ Line 27: / Line 27: @@
    "list": [
+     {
-       "isoCode": "AL",
+       "code": "AL",
        "name": "Alabama"
      },
+     {
-       "isoCode": "AK",
+       "code": "AK",
        "name": "Alaska"
      },
@@ Line 37: / Line 37: @@
 ...
+     {
-       "isoCode": "WI",
+       "code": "WI",
        "name": "Wisconsin"
      },
+     {
-       "isoCode": "WY",
+       "code": "WY",
        "name": "Wyoming"
+     }
    ],
    "links": [
-     "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces/", "rel": "self"}
+     "self": {"href": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces", "rel": "self"}
+   ]
+}
@@ Line 52: / Line 52: @@
 === Parameters ===
-; isoCode - ''string''
+; code - ''string''
-: The state/province code - ''e.g. NJ, IL, DC, CA, FL''
+: The state/province code (e.g. ''NJ'', ''IL'', ''DC'', ''CA'', ''FL'').
 ; name - ''string''
-: Full state/province name
+: The full state/province name.
 ; links - ''list''