Get all suburbs details.

Get suburb details for all suburbs.

URL:	https://api.trademe.co.nz/v1/Property/Sold/Suburbs.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	None
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

file_format

Enumeration (required)

The format of the response.

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

Returns

Details of all suburbs.

Cities

Collection of <BaseCityDetails> or null

Wrapper to store all cities and suburbs response

CityId

Integer

City Id

CityName

String or null

City Name

Suburbs

Collection of <BaseSuburbDetails> or null

List of suburbs under this city

SuburbId	Integer	Suburb Id
SuburbName	String or null	Suburb Name
ParentId	Integer	Parent Id
SuburbUrlSlug	String or null	Suburb Url Slug

Error

String or null

Error message

Example XML Response (switch to JSON)

<SoldSuburbsResponse xmlns="http://api.trademe.co.nz/v1">
  <Cities>
    <BaseCityDetails>
      <CityId>123</CityId>
      <CityName>ABC</CityName>
      <Suburbs>
        <BaseSuburbDetails>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <ParentId>123</ParentId>
          <SuburbUrlSlug>ABC</SuburbUrlSlug>
        </BaseSuburbDetails>
        <BaseSuburbDetails>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <ParentId>123</ParentId>
          <SuburbUrlSlug>ABC</SuburbUrlSlug>
        </BaseSuburbDetails>
      </Suburbs>
    </BaseCityDetails>
    <BaseCityDetails>
      <CityId>123</CityId>
      <CityName>ABC</CityName>
      <Suburbs>
        <BaseSuburbDetails>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <ParentId>123</ParentId>
          <SuburbUrlSlug>ABC</SuburbUrlSlug>
        </BaseSuburbDetails>
        <BaseSuburbDetails>
          <SuburbId>123</SuburbId>
          <SuburbName>ABC</SuburbName>
          <ParentId>123</ParentId>
          <SuburbUrlSlug>ABC</SuburbUrlSlug>
        </BaseSuburbDetails>
      </Suburbs>
    </BaseCityDetails>
  </Cities>
  <Error>ABC</Error>
</SoldSuburbsResponse>

Example JSON Response (switch to XML)

{
  "Cities": [
    {
      "CityId": 123,
      "CityName": "ABC",
      "Suburbs": [
        {
          "SuburbId": 123,
          "SuburbName": "ABC",
          "ParentId": 123,
          "SuburbUrlSlug": "ABC"
        },
        {
          "SuburbId": 123,
          "SuburbName": "ABC",
          "ParentId": 123,
          "SuburbUrlSlug": "ABC"
        }
      ]
    },
    {
      "CityId": 123,
      "CityName": "ABC",
      "Suburbs": [
        {
          "SuburbId": 123,
          "SuburbName": "ABC",
          "ParentId": 123,
          "SuburbUrlSlug": "ABC"
        },
        {
          "SuburbId": 123,
          "SuburbName": "ABC",
          "ParentId": 123,
          "SuburbUrlSlug": "ABC"
        }
      ]
    }
  ],
  "Error": "ABC"
}