Get Countries

method: getCountries

This API operation returns a list of Countries and their associated CountryID. You can exclude specified countries.

URL / Endpoint

GET /v1/lists/getCountries

Request

PropertyTypeDescription
ExcludeCountryIDs string Comma delimited string of CountryIDs. Countries to which the IDs pertain will be excluded. For example 134,154,161.

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body, or the HTTP GET method by passing parameters over the query string of the URI.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

Your API-Key is required with every request and can be passed in as a header or a query-string parameter. Don't have an API-Key? Get one now.

Samples

GET method

https://api-sandbox.adultwork.com/v1/lists/getCountries
  ?apiKey={your-api-key}
  &ExcludeCountryIDs=18%2C100%2C141

Response

PropertyTypeDescription
Countries Array of aws:Country List of Countries.

Response Sample

The following example returns a shortened list of Countries.

[
    {
        CountryID: 58
        CountryName: "Afghanistan"
        CountryISO2: "AF"
        CountryISO3: "AFG",
Nationality: "Afghan" } { CountryID: 108 CountryName: "Albania" CountryISO2: "AL" CountryISO3: "ALB",
Nationality: "Albanian" } { CountryID: 1 CountryName: "Algeria" CountryISO2: "DZ" CountryISO3: "DZA",
Nationality: "Algerian" } { CountryID: 212 CountryName: "American Samoa" CountryISO2: "AS" CountryISO3: "ASM",
Nationality: "American Samoan" } ]

<ArrayOfCountry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Country>
        <CountryID>58</CountryID>
        <CountryISO2>AF</CountryISO2>
        <CountryISO3>AFG</CountryISO3>
        <CountryName>Afghanistan</CountryName>
<Nationality>Afghan</Nationality> </Country> <Country> <CountryID>108</CountryID> <CountryISO2>AL</CountryISO2> <CountryISO3>ALB</CountryISO3> <CountryName>Albania</CountryName>
<Nationality>Albanian</Nationality> </Country> <Country> <CountryID>1</CountryID> <CountryISO2>DZ</CountryISO2> <CountryISO3>DZA</CountryISO3> <CountryName>Algeria</CountryName>
<Nationality>Algerian</Nationality> </Country> <Country> <CountryID>212</CountryID> <CountryISO2>AS</CountryISO2> <CountryISO3>ASM</CountryISO3> <CountryName>American Samoa</CountryName>
<Nationality>American Samoan</Nationality> </Country> <ArrayOfCountry>