View source

= GET /countries =
Retrieves a list of all supported countries.
__TOC__

== Request ==
<code>GET /countries</code>

==== Request Parameters ====
None.

=== URI Parameters ===
None.

== Response ==
Returns a dictionary containing list of countries with [http://www.iso.org/iso/iso-3166-1_decoding_table.html|ISO 3166-1 alpha-2] country codes and a link to obtain the provinces for each country.

=== Status Code ===
;200 OK
: Success
 
=== Response Body ===
 <nowiki>
{
  "list": [
    {
      "code": "US",
      "name": "United States of America",
      "provinces": "</nowiki>{{APIBaseURL}}<nowiki>/countries/US/provinces"
    },
    {
      "code": "BG",
      "name": "Bulgaria",
      "provinces": "</nowiki>{{APIBaseURL}}<nowiki>/countries/BG/provinces"
    }
  ],
  "links": [
    {"rel": "self", "href": "</nowiki>{{APIBaseURL}}<nowiki>/countries"}
  ]
}
  </nowiki>

==== Parameters ====
; list - ''list''
: List of countries with [http://www.iso.org/iso/iso-3166-1_decoding_table.html|ISO 3166-1 alpha-2] code and link to corresponding provinces list. Each element of the list has the following attributes:

:; code - ''string''
:: The [http://www.iso.org/iso/iso-3166-1_decoding_table.html|ISO 3166-1 alpha-2] code of the country.

:; name - ''string''
:: A descriptive name (in English) for the country.

:; provinces - ''URI''
:: A URI to the list of provinces for the given country.

; links - ''list''
: [[Hypermedia]] for this resource. Link to self will preserve filtering, sorting and pagination set by the request. Links to the first, last, previous and next pages will also be included if applicable.

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

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