Retrieve travel localities

Returns a list of districts and suburbs as used by TradeMe travel.

URL:	https://api.trademe.co.nz/v1/travelareas.{file_format}
HTTP Method:	GET
Requires Authentication?	No
Permission Required:	Public
Supported Formats:	XML, JSON
Rate Limited?	No

URL parameters

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Returns

Collection of <Locality>

A list of all localities.

LocalityId

Integer

LocalityId

Name

String or null

Name

Districts

Collection of <District> or null

Districts

DistrictId	Integer	DistrictId
Name	String or null	Name

Example XML Response (switch to JSON)

<LocalityCollection xmlns="http://api.trademe.co.nz/v1">
  <Locality>
    <LocalityId>123</LocalityId>
    <Name>ABC</Name>
    <Districts>
      <District>
        <DistrictId>123</DistrictId>
        <Name>ABC</Name>
      </District>
      <District>
        <DistrictId>123</DistrictId>
        <Name>ABC</Name>
      </District>
    </Districts>
  </Locality>
  <Locality>
    <LocalityId>123</LocalityId>
    <Name>ABC</Name>
    <Districts>
      <District>
        <DistrictId>123</DistrictId>
        <Name>ABC</Name>
      </District>
      <District>
        <DistrictId>123</DistrictId>
        <Name>ABC</Name>
      </District>
    </Districts>
  </Locality>
</LocalityCollection>

Example JSON Response (switch to XML)

[
  {
    "LocalityId": 123,
    "Name": "ABC",
    "Districts": [
      {
        "DistrictId": 123,
        "Name": "ABC"
      },
      {
        "DistrictId": 123,
        "Name": "ABC"
      }
    ]
  },
  {
    "LocalityId": 123,
    "Name": "ABC",
    "Districts": [
      {
        "DistrictId": 123,
        "Name": "ABC"
      },
      {
        "DistrictId": 123,
        "Name": "ABC"
      }
    ]
  }
]