Resource type:regions
In order for a geographical assignment of prospective buyer and estate is possible, often the details of the place and postcode are not sufficient. onOffice works here with “regional additions/regionalen Zusätzen”.
With this API call these regions can be retrieved. If a parent region is inactive, active child regions are not listed.
Parameters:
language
language
Example:
{
"actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:get",
"resourceid":"",
"identifier":"",
"resourcetype":"regions",
"parameters":
{
"language":"DEU"
}
}
Response:
regions
Regions and subregions together with related information
Example response:
...
"id": "Verkaufsgebiet C",
"type": "",
"elements": {
"id": "Verkaufsgebiet C",
"name": "Rheinland",
"description": "Rheinland",
"postalcodes": [
[
"52000",
"53000"
]
],
"state": "NRW",
"country": "Deutschland",
"children": {
"indMulti1274Select5431": {
"id": "indMulti1274Select5431",
"name": "Aachen",
"description": null,
"postalcodes": [
[
"52060",
"52074"
]
],
"state": "Nordrhein-Westfalen",
"country": "Deutschland",
"children": []
},
"indMulti1274Select5437": {
"id": "indMulti1274Select5437",
"name": "Koeln",
"description": null,
"postalcodes": [
[
"50650",
"51150"
]
],
"state": "Nordrhein-Westfalen",
"country": "Deutschland",
"children": {
"indMulti1274Select5440": {
"id": "indMulti1274Select5440",
"name": "Chorweiler",
"description": "Chorweiler ist ein noerdlicher Stadtbezirk von Koeln",
"postalcodes": [
"50765"
],
"state": "Nordrhein-Westfalen",
"country": "Deutschland",
"children": []
},
"indMulti1274Select5438": {
"id": "indMulti1274Select5438",
"name": "Nippes",
"description": "Nippes ist der Stadtbezirk 5 von Koeln",
"postalcodes": [
"50733"
],
"state": "Nordrhein-Westfalen",
"country": "Deutschland",
"children": []
}
}
}
}
...