Geohierarchy API

The Geohiarchy API retrieves all continents on earth, its countries, its regions, its cities and its quarters.

http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/{continent-id}/country/{country-id}/region/{region-id}/city/{city-id}/quarter/{quarter-id}

Note

  • Only method GET is supported

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

  • At least a System Key is required for this operation. Take a look into the two-legged OAuth Authentication for further details.

Request

Path Parameters

  • continent-id - if provided, a specific continent is returned.
  • country-id - if provided, a specific country is returned.
  • region - if provided, all regions of a specific country are returned.
  • region-id - if provided, a specific region is returned.
  • city - if provided, all cities of a specific region are returned.
  • city-id - if provided, a specific city is returned.
  • quarter - if provided, all quarters of a specific city are returned.
  • quarter-id - if provided, a specific quarter is returned.

Query Parameters

none.

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request. Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK - The requested operation was successful.
  • Status 400 Bad Request - It seems that the structure of the request URI is wrong. Check your request parameters.
  • Status 401 Unauthorized - You doesn't communicate oauth with us.
  • Status 403 Forbidden - You're not allowed the use that API or need a additional permission. Write us an email with a short description of your usecases.

Header

No special headers.

URI and Body

http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gis:continents xmlns:common="http://rest.immobilienscout24.de/schema/common/1.0" xmlns:gis="http://rest.immobilienscout24.de/schema/platform/gis/1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/1" id="1" label="Europa"/>
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/2" id="2" label="Asien"/>
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/3" id="3" label="Afrika"/>
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/4" id="4" label="Amerika"/>
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/5" id="5" label="Australien"/>
    <Continent xlink:href="http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/6" id="6" label="Antarktika"/>
</gis:continents>

JSON

{
  "gis.continents": [
    {
      "Continent": [
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/1",
          "@id": "1",
          "@label": "Europa"
        },
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/2",
          "@id": "2",
          "@label": "Asien"
        },
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/3",
          "@id": "3",
          "@label": "Afrika"
        },
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/4",
          "@id": "4",
          "@label": "Amerika"
        },
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/5",
          "@id": "5",
          "@label": "Australien"
        },
        {
          "@xlink.href": "http://rest.immobilienscout24.de/restapi/api/gis/v1.0/continent/6",
          "@id": "6",
          "@label": "Antarktika"
        }
      ]
    }
  ]
}