Get Regions

method: getRegions

This API operation returns a list of Regions and their associated RegionID based on the CountryID passed in.

URL / Endpoint

GET /v1/lists/getRegions

Request

PropertyTypeDescription
CountryID integer Required. This is the ID of the Country that you wish to have it's associated Regions returned. See the GetCountries method.

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/getRegions
  ?apiKey={your-api-key}
  &CountryID=158

Response

PropertyTypeDescription
Regions Array of aws:Region List of Regions from a specified Country.

Response Sample

The following example returns a shortened list of Regions for the CountryID 158, the United Kingdom.

[
    {
        RegionID: 14
        RegionName: "Channel Islands"
    }
    {
        RegionID: 8
        RegionName: "East Midlands"
    }
    {
        RegionID: 9
        RegionName: "East of England (Anglia)"
    }
    {
        RegionID: 1
        RegionName: "London"
    }
    {
        RegionID: 6
        RegionName: "North East"
    }
]
<ArrayOfRegion xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Region>
        <RegionID>14</RegionID>
        <RegionName>Channel Islands</RegionName>
    </Region>
    <Region>
        <RegionID>8</RegionID>
        <RegionName>East MIDlands</RegionName>
    </Region>
    <Region>
        <RegionID>9</RegionID>
        <RegionName>East of England (Anglia)</RegionName>
    </Region>
    <Region>
        <RegionID>1</RegionID>
        <RegionName>London</RegionName>
    </Region>
    <Region>
        <RegionID>6</RegionID>
        <RegionName>North East</RegionName>
    </Region>
<ArrayOfRegion>