Get Counties

method: getCounties

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

URL / Endpoint

GET /v1/lists/getCounties

Request

PropertyTypeDescription
RegionID integer Required. This is the ID of the Region that you wish to have it's associated Counties returned. See the GetRegions 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/getCounties
  ?apiKey={your-api-key}
  &RegionID=10

Response

PropertyTypeDescription
Counties Array of aws:County List of Counties from a specified Region.

Response Sample

The following example returns a shortened list of Counties for the RegionID 2, the South East.

[ 
    {
        CountyID: 174
        CountyName: "Berkshire"
    }
    {
        CountyID: 175
        CountyName: "Buckinghamshire"
    }
    {
        CountyID: 176
        CountyName: "East Sussex"
    }
    {
        CountyID: 177
        CountyName: "Hampshire"
    }
    {
        CountyID: 178
        CountyName: "Isle of Wight"
    }
    {
        CountyID: 179
        CountyName: "Kent"
    }
    {
        CountyID: 180
        CountyName: "Oxfordshire"
    }
    {
        CountyID: 181
        CountyName: "Surrey"
    }
    {
        CountyID: 182
        CountyName: "West Sussex"
    }
]
                    
<ArrayOfCounty xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <County>
        <CountyID>174</CountyID>
        <CountyName>Berkshire</CountyName>
    </County>
    <County>
        <CountyID>175</CountyID>
        <CountyName>Buckinghamshire</CountyName>
    </County>
    <County>
        <CountyID>176</CountyID>
        <CountyName>East Sussex</CountyName>
    </County>
    <County>
        <CountyID>177</CountyID>
        <CountyName>Hampshire</CountyName>
    </County>
    <County>
        <CountyID>178</CountyID>
        <CountyName>Isle of Wight</CountyName>
    </County>
    <County>
        <CountyID>179</CountyID>
        <CountyName>Kent</CountyName>
    </County>
    <County>
        <CountyID>180</CountyID>
        <CountyName>Oxfordshire</CountyName>
    </County>
    <County>
        <CountyID>181</CountyID>
        <CountyName>Surrey</CountyName>
    </County>
    <County>
        <CountyID>182</CountyID>
        <CountyName>West Sussex</CountyName>
    </County>
<ArrayOfCounty>