MultiRoute Go! API-Schnittstelle

Gehfolgen-Steuerung

Ausgaben

Da immer ein gültiger Benutzer benötigt wird, muss man sich entweder mittels Basic Auth (http://username:password@domain/) anmelden,
oder es wird ein Benutzer fest hinterlegt. Dieser feste Benutzer wird dann in einer Konfiguration eintragen.

Wenn zwischen verschiedenen Ausgaben gewechselt werden soll, kann dies per Aufruf erfolgen.
Dieser ändert die Ausgabe des Benutzers.

http://domain/fernsteuerung/ausgabe_wechseln?ausgabe=<Ausgabename>
Oder man kann die Ausgabe als optionalen Parameter an die anderen Aufrufe mit übergeben.

Gehfolgen-Status

Informationen zu allen Gehfolgen (einer Ausgabe)
Es werden entweder alle angezeigt, oder nur die mit dem jeweiligen Status.

http://domain/fernsteuerung/gehfolgen
http://domain/fernsteuerung/gehfolgen/error
http://domain/fernsteuerung/gehfolgen/pending
http://domain/fernsteuerung/gehfolgen/unknown
http://domain/fernsteuerung/gehfolgen/success

Optionale Parameter:
limit (default 100)
offset (default 0)
ausgabe (default die vom User)
verteilbezirk (Verteilbezirk-Nummer (Name))
abonnenten (default alle) true=Abonnenten; false=Vollverteilung
fussweg (default alle) true=Fußweg bevorzugt; false=kein Fußweg bevorzugt

http://domain/fernsteuerung/gehfolgen?limit=10&offset=0

Rückgabewert ist ein JSON Array:

{"id":3607,"verteilbezirk":"51043501570","status":"pending"},{"id":3606,"verteilbezirk":"WSP_P193d","status":"pending"},
{"id":3605,"verteilbezirk":"WSP_P193","status":"pending"},{"id":3604,"verteilbezirk":"WSP_P193w","status":"pending"},
{"id":3603,"verteilbezirk":"WSP_P193c","status":"pending"},{"id":3602,"verteilbezirk":"WSP_P193f","status":"pending"},
{"id":3601,"verteilbezirk":"test","status":"pending"},{"id":3600,"verteilbezirk":"8654","status":"success"},
{"id":3599,"verteilbezirk":"8654","status":"success"},{"id":3598,"verteilbezirk":"8654","status":"success"}

CSV-Export

http://domain/fernsteuerung/gehfolgen/export/abonnenten/detail
http://domain/fernsteuerung/gehfolgen/export/abonnenten/zusammenfassung
http://domain/fernsteuerung/gehfolgen/export/vollbesteckung/detail
http://domain/fernsteuerung/gehfolgen/export/vollbesteckung/zusammenfassung

Informationen zu einer Gehfolge (Ausgabe spielt keine Rolle):

http://domain/fernsteuerung/gehfolge/3603

Rückgabewert ist ein JSON Object:

{"id":3603,"verteilbezirk":"WSP_P193c","status":"unknown","grenzdistanz":10,"zugang_fussweg":true,"abonnenten":true,"ignore_starthaus":true}

Download der Trägerdokumente bzw. Info und Details zu einer Gehfolge

http://domain/fernsteuerung/gehfolge/3603/gpx (optional: "/gpx?type=waypoint,route,track" - Default: track)

http://domain/fernsteuerung/gehfolge/3603/excel
http://domain/fernsteuerung/gehfolge/3603/image
http://domain/fernsteuerung/gehfolge/3603/strassenliste -> pdf
http://domain/fernsteuerung/gehfolge/3603/bezirkskarte -> pdf
http://domain/fernsteuerung/gehfolge/3603/gehfolge -> pdf
http://domain/fernsteuerung/gehfolge/3603/detail -> csv
http://domain/fernsteuerung/gehfolge/3603/zusammenfassung -> csv
http://domain/fernsteuerung/gehfolge/3603/detail.json -> json
http://domain/fernsteuerung/gehfolge/3603/zusammenfassung.json -> json

JSON Objekt Beispiele:

Achtung: Die folgenden Keys sind optional:

Zusammenfassung

{
    "verteilbezirk_nr": "Bezirk 10",
    "gehfolge_id": 4607,
    "zustellerhaus": true,
    "fussweg": false,
    "nur_abonnenten": true,
    "datenstand_osm": "01.01.1970",
    "berechnet_am": "29.09.2015 15:19",
    "grenzdistanz": 10,
    "dauer": 0.25,
    "strecke_im_gebiet": 329,
    "strecke_gesamt": 1246,
    "hinweg": 917,
    "rueckweg": 0,
    "hauszugangsdistanzen": 22,
    "anzahl_haeuser_mit_hauszugangsdistanz": 5,
    "privathaushalte": 17,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 11,
    "hoehenprofil_min": 36,
    "hoehenprofil_max": 48,
    "hoehenprofil_aufstieg": 12
}

Detail

[{
    "geb_id": "abc1",
    "gehfolge_id": 4607,
    "nr": 1,
    "strasse": "Gendarmenmarkt",
    "hausnummer": "2",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": null,
    "dauer": null,
    "strecke": null,
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 0
}, {
    "geb_id": "abc2",
    "gehfolge_id": 4607,
    "nr": 2,
    "strasse": "Wilhelmstraße",
    "hausnummer": "96",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": 8,
    "dauer": 664,
    "strecke": 917,
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 0
}, {
    "geb_id": "abc3",
    "gehfolge_id": 4607,
    "nr": 3,
    "strasse": "Voßstraße",
    "hausnummer": "35",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": 4,
    "dauer": 129,
    "strecke": 179,
    "privathaushalte": 3,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 2
}, {
    "geb_id": "abc4",
    "gehfolge_id": 4607,
    "nr": 4,
    "strasse": "Voßstraße",
    "hausnummer": "34",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": 3,
    "dauer": 22,
    "strecke": 31,
    "privathaushalte": 4,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 3
}, {
    "geb_id": "abc5",
    "gehfolge_id": 4607,
    "nr": 5,
    "strasse": "Voßstraße",
    "hausnummer": "33",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": 3,
    "dauer": 27,
    "strecke": 38,
    "privathaushalte": 4,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 2
}, {
    "geb_id": "abc6",
    "gehfolge_id": 4607,
    "nr": 6,
    "strasse": "Voßstraße",
    "hausnummer": "27",
    "plz": "10117",
    "ort": "Berlin",
    "verteilbezirk_nr": "Bezirk 10",
    "hauszugangs_distanz": 4,
    "dauer": 58,
    "strecke": 81,
    "privathaushalte": 6,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "abonnenten": 4
}]

Gehfolgenberechung starten

Für alle Verteilbezirke der (Ausgabe)

http://domain/fernsteuerung/gehfolgen/berechnen

Optionale Parameter:
use_save_settings Verwende nur die gespeicherten Einstellungen von Verteilbezirk/Ausgabe/Kunde
grenzdistanz Hauszugangsdistanz (HZD) Grenzwert (default Kundeneinstellung)
abonnenten Gehfolge nur für Abonnenten berechnen (default false)
ignore_starthaus Starthaus automatisch optimieren (default false) Starhaus des Beziks wird verwendet
transport fuss oder kfz (default fuss)
zugang_fussweg Zum Haus nächstgelegene Fußwege als Zugang bevorzugen (default false) Funktioniert nur bei transport=fuss
ignore_street_name Straßennamen ignorieren (default false) Bei Problemen wenn in OSM ein anderer Straßennamen enthalten ist wie in den Adresse-Daten
steckzeit_erste (default Kundeneinstellung)
steckzeit_folgende (default Kundeneinstellung)
speed Geschwindigkeit (default Kundeneinstellung oder 5)
ruestzeit Rüstzeit (default Kundeneinstellung oder 0)
ausgabe Name der Ausgabe (default die vom User)
Parameter für Depot-Optimierung:
kapazitaet Anzahl der Zeitungen
start_kapazitaet Anzahl der Zeitungen die der Zusteller schon dabei hat. (default 0)
bzw.
kapazitaet_kg Tragekapazität des Zustellers in kg)
start_kapazitaet_kg Tragekapazität des Zustellers in kg beim Start (~ Anzahl der Zeitungen die der Zusteller schon dabei hat)(default 0)
mediengewicht Gewicht eines Mediums in Gramm

METHODE [POST oder GET]

Rückgabewert ist ein JSON Object:

{"status":200,"gehfolgen_ids":[3601,3602,3603,3604,3605,3606,3607,3608,3609]}
{"status":500,"error":{"text":"kein Verteilbezirk gefunden","data":null}}

Für einen Verteilbezirk

http://domain/fernsteuerung/gehfolge/berechnen?verteilbezirk=123

Parameter: |verteilbezirk| Nr. des Verteilbezirks|
Optionale Parameter:
siehe: Für alle Verteilbezirke der (Ausgabe)

METHODE [POST oder GET]

Rückgabewert ist ein JSON Object:

{"status":200,"gehfolgen_ids":[1]}
{"status":500,"error":{"text":"kein Verteilbezirk gefunden","data":null}}

Abbrechen der Gehfolgenberechung (nur die von User)

http://domain/fernsteuerung/gehfolgen/abbrechen

Beispiele

PHP-Beispiel letzte berechnete Gehfolge für bestimmen Verteilbezirk

Datenaustausch (JSON)

Der Datenaustausch ist auf JSON Objekte ausgelegt.
Beim Übermitteln von JSON Objekten(POST) muss man den
Header: "Content-Type: application/json" mit angeben.

Es ist aber auch möglich die Abfrage über GET bzw. normale POST Request zu machen.
Dies ist dann sinnvoll, wenn ich Daten vom Server hole.

Adressen

Adressen abrufen

http://domain/fernsteuerung/adresse

Parameter (optional):

limit Limit
offset Offset
koordinaten Gibt Koordinaten mit aus (optional default false)
kommentar Gibt Kommentar mit aus (optional default false)
alle_ausgaben Gibt nur zugeordnete Adressen aus (Bezirk und Ausgabe werden als Array ausgegeben (Adresse kann in verschiedenen Ausgaben sein) (optional default false)
starthaus Gibt nur Adressen die Starthaus sind aus (Bezirk und Ausgabe werden als Array ausgegeben (Adresse kann in verschiedenen Ausgaben sein) (optional default false)
zustellerhaus Gibt nur Adressen die Zustellerhaus sind aus (Bezirk und Ausgabe werden als Array ausgegeben (Adresse kann in verschiedenen Ausgaben sein) (optional default false)
endhaus Gibt nur Adressen die Endhaus sind aus (Bezirk und Ausgabe werden als Array ausgegeben (Adresse kann in verschiedenen Ausgaben sein) (optional default false)
depot Gibt nur Adressen die Depot sind aus (Bezirk und Ausgabe werden als Array ausgegeben (Adresse kann in verschiedenen Ausgaben sein) (optional default false)
ausgabe Name der Ausgabe (funktioniert nur mit [alle_ausgaben,starthaus,zustellerhaus,endhaus,depot])

Optionale Filter Parameter:

oi Gebäude ids
plz Postleitzahl
ort Ort
ort_zusatz Ortsteil
strasse Strasse
hausnummer Hausnummer
hausnummer_zusatz Hausnummer Zusatz
street_oi Straßenabschnitts-ID
manuell true (Gibt nur durch Kartenklick erfasste Adressen aus (GBC Nummer))

Rückgabe:

[{
    "oi": "OOI1411",
    "plz": "10115",
    "ort": "Berlin",
    "ort_zusatz": null,
    "strasse": "Ackerstraße",
    "hausnummer": "172",
    "hausnummer_zusatz": "",
    "is_active": true,
    "privathaushalte": 1,
    "gewerbebetriebe": 2
}, {
    "oi": "OOI1412",
    "plz": "10115",
    "ort": "Berlin",
    "ort_zusatz": null,
    "strasse": "Ackerstraße",
    "hausnummer": "173",
    "hausnummer_zusatz": "",
    "is_active": true,
    "privathaushalte": null,
    "gewerbebetriebe": null
}, {
    "oi": "OOI1413",
    "plz": "10115",
    "ort": "Berlin",
    "ort_zusatz": null,
    "strasse": "Ackerstraße",
    "hausnummer": "174",
    "hausnummer_zusatz": "",
    "is_active": true,
    "privathaushalte": null,
    "gewerbebetriebe": null
}]

Rückgabe mit alle_ausgaben:

[{
    "oi": "12760120275582",
    "plz": "35075",
    "ort": "Gladenbach",
    "ortsteil": "",
    "ort_zusatz": null,
    "strasse": "Adolf-Theis-Straße",
    "hausnummer": "12",
    "hausnummer_zusatz": "",
    "is_active": true,
    "notice": null,
    "street_oi": "0000386499",
    "privathaushalte": 2,
    "gewerbebetriebe": 0,
    "werbeverweigerer": null,
    "ausgabe_bezirk": [{
        "nr": "B201015Z",
        "ausgabe": "Freitag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Montag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Dienstag" 
    }, {
        "nr": "B201015V",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Donnerstag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Samstag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Sonntag" 
    }, {
        "nr": "T201055",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }, {
        "nr": "T201055",
        "ausgabe": "Test" 
    }]
}, {
    "oi": "12760120388646",
    "plz": "35075",
    "ort": "Gladenbach",
    "ortsteil": "",
    "ort_zusatz": null,
    "strasse": "Adolf-Theis-Straße",
    "hausnummer": "13",
    "hausnummer_zusatz": "",
    "is_active": true,
    "notice": null,
    "street_oi": "0000386499",
    "privathaushalte": 2,
    "gewerbebetriebe": 0,
    "werbeverweigerer": null,
    "ausgabe_bezirk": [{
        "nr": "T201055",
        "ausgabe": "Test" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Montag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Dienstag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Donnerstag" 
    }, {
        "nr": "B201015V",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Freitag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Samstag" 
    }, {
        "nr": "T201055",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }]
}, {
    "oi": "12760120264124",
    "plz": "35075",
    "ort": "Gladenbach",
    "ortsteil": "",
    "ort_zusatz": null,
    "strasse": "Adolf-Theis-Straße",
    "hausnummer": "14",
    "hausnummer_zusatz": "",
    "is_active": true,
    "notice": null,
    "street_oi": "0000386499",
    "privathaushalte": 1,
    "gewerbebetriebe": 0,
    "werbeverweigerer": null,
    "ausgabe_bezirk": [{
        "nr": "T201055",
        "ausgabe": "Test" 
    }, {
        "nr": "B201015V",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Sonntag" 
    }, {
        "nr": "T201055",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Donnerstag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Vollverteilung" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Test Meier Abo 24.03.17" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Freitag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Dienstag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Montag" 
    }, {
        "nr": "B201015Z",
        "ausgabe": "Samstag" 
    }]
}]

Adressen Hinzufügen/Updaten

http://domain/fernsteuerung/add_and_update_adresse

Parameter:

adresse Adresse Parameter
insert true(default) oder false. Nur neue Adressen werden hinzugefügt
update true(default) oder false. Bestehende Adressen werden geupdated

Adresse Parameter:

oi Gebäude ID (required)
street_oi Straßen ID
longitude Längengrad (required)
latitude Breitengrad (required)
plz Postleitzahl
ort Ort
ort_zusatz Ort Zusatz
ortsteil Ortsteil
strasse Strasse
hausnummer Hausnummer
hausnummer_zusatz Hausnummer Zusatz
is_active Haus ist aktiv (required)
privathaushalte Anzahl Werbeverweigerer (integer)
gewerbebetriebe Anzahl Werbeverweigerer (integer)
werbeverweigerer Anzahl Werbeverweigerer (integer)
{
"update": true,
"insert": true, 
"adresse": [{
    "oi": "GBC93385",
    "plz": "10119",
    "ort": "Berlin",
    "ort_zusatz": null,
    "strasse": "Schwedter Straße",
    "hausnummer": "22",
    "hausnummer_zusatz": "",
    "is_active": true,
    "notice": null,
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "werbeverweigerer": 0,
    "longitude": 52.5347133208835,
    "latitude": 13.4075689315796
}, {
    "oi": "GBC360693",
    "plz": "84030",
    "ort": "Ergolding",
    "ort_zusatz": null,
    "strasse": "Schinderstraßl",
    "hausnummer": "5",
    "hausnummer_zusatz": "D",
    "is_active": true,
    "notice": null,
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "werbeverweigerer": null,
    "longitude": 12.1660333871841,
    "latitude": 48.5649005287186
}]
 }

Adressen löschen

http://domain/fernsteuerung/delete_adresse

oi Adresse ID
{
"oi": ["3353880","2739684","DEBYv00099005586","DEBYv00099000331","DEBYv00099029356","DEBYv00099001121","DEBYv00099000328"]
}

Abonnenten

Abonnenten abrufen

http://domain/fernsteuerung/gebiet/abonnent (Gebiets Ausgabe)
http://domain/fernsteuerung/bezirk/abonnent (Bezirks Ausgabe)

Parameter (optional):

limit Limit
offset Offset
ausgabe Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)

Rückgabe:

[{"oi":"GBC372190","abonnenten":0},{"oi":"GBC372192","abonnenten":7},{"oi":"DEBYv00099001290","abonnenten":1}]

Abonnenten Hinzufügen/Updaten

http://domain/fernsteuerung/gebiet/add_and_update_abonnent (Gebiets Ausgabe)
http://domain/fernsteuerung/bezirk/add_and_update_abonnent (Bezirks Ausgabe)

Parameters

abonnent Abonnent Parameters
insert true(default) oder false. Nur neue Gebiete werden hinzugefügt
update true(default) oder false. Bestehende Gebiete werden geupdated
ausgabe Name der Ausgabe (optional: defaul=Aktuelle Ausgabe des Benutzers)
Abonnent Parameter
oi Gebäude ID
abonnenten Anzahl Abonnent integer
title Abo Titel optional
abo_name Abonnent Name, Nr ... (darf kein ; enthalten) optional
abo_vorname Abonnent Vorname (darf kein ; enthalten) optional
abo_nachname Abonnent Nachname (darf kein ; enthalten) optional
abo_hint Hinweis Zustellbesonderheit optional
abo_nr Abo Nummer (Zusie) optional
abo_pva Planvertriebsausgabe (Zusie) optional
abo_bper Bezugsperiode (Zusie) optional
abo_ub Unterbrechung (Zusie) optional
abo_valid_from gültig von (Zusie) optional
abo_valid_to gültig bis (Zusie) optional
Abonnent Parameter mit Straßen ID
street_oi Straßen ID
hausnummer Hausnummer
hausnummer_zusatz Hausnummer Zusatz (optional, der Zusatz kann auch bei der Hausnummer mit dabei sein.)
abonnenten Anzahl Abonnent integer
title Abo Titel optional
abo_name Abonnent Name, Nr ... (darf kein ; enthalten) optional
abo_vorname Abonnent Vorname (darf kein ; enthalten) optional
abo_nachname Abonnent Nachname (darf kein ; enthalten) optional
abo_hint Hinweis Zustellbesonderheit optional
abo_nr Abo Nummer (Zusie) optional
abo_pva Planvertriebsausgabe (Zusie) optional
abo_bper Bezugsperiode (Zusie) optional
abo_ub Unterbrechung (Zusie) optional
abo_valid_from gültig von (Zusie) optional
abo_valid_to gültig bis (Zusie) optional
{
"update": true,
"insert": true, 
"abonnent": [{"oi":"3353880","abonnenten":3},{"oi":"2739684","abonnenten":3}]
 }
{
"update": true,
"insert": true, 
"abonnent": [{"street_oi":"1234", "hausnummer": "2","abonnenten":3},{"street_oi":"4567", "hausnummer": "12","abonnenten":3},{"street_oi":"4567", "hausnummer": "21","abonnenten":3}]
 }

Abonnent-Parameter wie z.B. abo_name oder title an einer oder mehreren Adressen übergeben:
Die Anzahl der Paramter müssen für jeden Datensatz gleich sein. Es ist wie, wenn man eine Tabelle hochlädt, da sind auch für jede Spalte Daten vorhanden.

{
"update": true,
"insert": true, 
"abonnent": [{"street_oi":"1234", "hausnummer": "2","abonnenten":1,"title": "SZ", "abo_name": "Fritz Huber"},{"street_oi":"1234", "hausnummer": "2","abonnenten":1,"title": "SZ", "abo_name": "Hans Meier"},{"street_oi":"1234", "hausnummer": "2","abonnenten":1,"title": "TZ", "abo_name": "Hans Meier"},{"street_oi":"4567", "hausnummer": "12","abonnenten":1,"title": "TZ", "abo_name": "Hansi Maier"},{"street_oi":"4567", "hausnummer": "21","abonnenten":3,"title": "TZ", "abo_name": "Altenheim"}]
 }

Abonnenten löschen

http://domain/fernsteuerung/gebiet/delete_abonnent (Gebiets Ausgabe)
http://domain/fernsteuerung/bezirk/delete_abonnent (Bezirks Ausgabe)

oi Adresse ID
ausgabe Name der Ausgabe (defaul=Aktuelle Ausgabe des Benutzers)
all (optional) true , alle Abonnenten der Ausgabe werden gelöscht.
{
"oi": ["3353880","2739684","DEBYv00099005586","DEBYv00099000331","DEBYv00099029356","DEBYv00099001121","DEBYv00099000328"]
}

Gebiet

Das Gebiet (= Zelle) ist die untergeordnete Ebene, wenn zwei Ebenen verfügbar sind. Auf dieser Ebene werden die Zuordnungen zu den Gebäuden (Adressen) vorgenommen. Aus einem oder mehreren Gebieten werden durch die Zuordnung Gebiet=>Bezirk Bezirke (= Trägerbezirke) gebildet.
Ist nur eine Ebene vorhanden, so bildet ein Gebiet den Trägerbezirk (Regelfall).

Gebiete abrufen

http://domain/fernsteuerung/gebiet/

Parameter (optional):

nr Nummer(n) der Gebiete
limit Limit
offset Offset
ausgabe Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)

Rückgabe:

[{
    "nr": "1200",
    "name": "",
    "privathaushalte": 1,
    "gewerbebetriebe": 2,
    "abonnenten": 10,
    "limit_plz": "",
    "starthaus": "1",
    "zustellerhaus": "2",
    "endhaus": "3" 
}, {
    "nr": "1300",
    "name": "",
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "abonnenten": 0,
    "limit_plz": "",
    "starthaus": null,
    "zustellerhaus": null,
    "endhaus": null
}, {
    "nr": "1400",
    "name": "",
    "privathaushalte": 0,
    "gewerbebetriebe": 0,
    "abonnenten": 0,
    "limit_plz": "",
    "starthaus": null,
    "zustellerhaus": null,
    "endhaus": null
}]

Optionale Ausgabe wenn in Kundenverwaltung ausgewählt:
privathaushalte, gewerbebetriebe, werbeverweigerer, abonnenten
limit_plz
starthaus, zustellerhaus, endhaus (Gebäude ID (oi))

Gebiet Hinzufügen/Updaten

http://domain/fernsteuerung/gebiet/add_and_update

Parameter:

gebiet Gebiet Parameter
insert true(default) oder false. Nur neue Gebiete werden hinzugefügt
update true(default) oder false. Bestehende Gebiete werden geupdated
ausgabe Name der Ausgabe (optional: default=Aktuelle Ausgabe des Benutzers)

Gebiet Parameter (Achtung: beim Einfügen von mehreren Gebieten muss immer die gleiche Anzahl der Parameter angegeben werden):

nr Gebietsnummer
name Gebietsname (optional)
limit_plz Adressen limitiert auf Postleitzahl(en) (optional)
starthaus oi Starthaus (optional)
zustellerhaus oi Zustellerhaus (optional)
endhaus oi Endhaus (optional)

Beispiel:

{
"update": true,
"insert": true, 
"gebiet": [{
    "nr": "1200",
    "name": "Gebiet 1",
    "limit_plz": "12345,23456",
    "starthaus": "1",
    "zustellerhaus": "2",
    "endhaus": "3" 
}, {
    "nr": "1300",
    "name": "Gebiet 2",
    "limit_plz": "",
    "starthaus": null,
    "zustellerhaus": null,
    "endhaus": null
}]
 }

Gebiet löschen

http://domain/fernsteuerung/gebiet/delete

Parameter:

nr Nummer des Gebietes/Nummern der Gebiete
ausgabe Name der Ausgabe (optional: default=Aktuelle Ausgabe des Benutzers)
{
  nr: ["1","2"]
}

Gebietsdefinition

http://domain/fernsteuerung/gebiet/definition

Parameter (optional):

gebiet Nummer(n) der Gebiete
limit Limit
offset Offset
ausgabe Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)

Rückgabe:

[{"gebiet":"1234","oi":["1","2","3","4"],"ausgabe":"1234"},{"gebiet":"2345","oi":["5","6","7","8"],"ausgabe":"1234"}]

Gebietsdefinition hinzufügen bzw. löschen

http://domain/fernsteuerung/gebiet/add_definition
http://domain/fernsteuerung/gebiet/delete_definition

Parameter:

oi Adresse ID
gebiet Nummer des Gebietes
ausgabe Name der Ausgabe (optional default=Aktuelle Ausgabe des Benutzers)
geom Geometrien neu zeichnen (optional default=false); ACHTUNG: Bitte nur verwenden wenn die Geometrien vom System erzeugt wurden.
append Modus beim Hinzufügen (optional default=true); Alle Änderungen werden nur innerhalb der Ausgabe angewandt.
true: Zuordnung wird einfach hinzugefügt (Überlappungen mit anderen Gebieten sind möglich)
false: die gesamte alte Zuordnung des Gebietes wird als erstes gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind möglich)
replace: Alle Zuordnungen der Adressen werden gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind nicht möglich)
delete_replace: Die gesamte alte Zuordnung des Gebietes wird als erstes gelöscht. Alle Zuordnungen der Adressen zu anderen Gebieten werden gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind nicht möglich)
all Modus beim Löschen (optional default=false); Die Zuordnung wird gelöscht
{
  "oi": ["1","2","3"],
  "gebiet": "11",
  "ausgabe": "1234" 
}

bzw.

http://domain/fernsteuerung/gebiet/add_definition?ausgabe=1234&gebiet=11&oi=1,2,3
http://domain/fernsteuerung/gebiet/delete_definition?ausgabe=1234&gebiet=11&oi=1,2,3

Bekannte Fehlermeldungen:

{"text":"Ausgabe nicht gefunden","status":500}
{"text":"Kein Gebiet übergeben","status":500}
{"text":"Keine Adresse übergeben","status":500}
{"text":"Daten wurden nicht übernommen","status":500}

Gebietsdefinition hinzufügen (Mit Street-ID)

http://domain/fernsteuerung/gebiet/add_definition_with_street_oi

Parameter:

adresse Adresse Params
gebiet Nummer des Gebietes
ausgabe Name der Ausgabe (optional default=Aktuelle Ausgabe des Benutzers)
append Modus beim Hinzufügen (optional default=true); Alle Änderungen werden nur innerhalb der Ausgabe angewandt.
true: Zuordnung wird einfach hinzugefügt (Überlappungen mit anderen Gebieten sind möglich)
false: die gesamte alte Zuordnung des Gebietes wird als erstes gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind möglich)
replace: Alle Zuordnungen der Adressen werden gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind nicht möglich)
delete_replace: Die gesamte alte Zuordnung des Gebietes wird als erstes gelöscht. Alle Zuordnungen der Adressen zu anderen Gebieten werden gelöscht. Dann wird die neue Zuordnung geladen. (Überlappungen mit anderen Gebieten sind nicht möglich)
geom Geometrien neu zeichnen (optional default=false); ACHTUNG: Bitte nur verwenden wenn die Geometrien vom System erzeugt wurden.
Adresse Params:
street_oi Straßen ID
nr_von von Hausnummer
nr_bis Bis Hausnummer
Optionale Adresse Params:
nrzusatz_von von Hausnummer Zusatz
nrzusatz_bis Bis Hausnummer Zusatz
kennz Kennzahl A: Alle, G:Nur gerade Hausnummern, U: Nur ungerade Hausnummern. optional(default A)
{
  "adresse": [{"street_oi":"1234", "nr_von": "2","nr_bis":"998","kennz":"G"},{"street_oi":"4567", "nr_von": "1","nr_bis":"999","kennz":"A"}],
  "gebiet": "8765",
  "ausgabe": "default" 
}
gegeben Hausnummer 20, 20A, 20B, 21, 21A, 21B, 22, 22A,22B

Bisher:
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20" }]} => 20, 20A, 20B
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "22" }]} => 20, 20A, 20B, 21, 21A, 21B, 22, 22A,22B

Neu:
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20", "nrzusatz_von": "", "nrzusatz_bis": "" }]} => 20
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20", "nrzusatz_von": "A", "nrzusatz_bis": "B" }]} => 20A, 20B
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20", "nrzusatz_von": "", "nrzusatz_bis": "A" }]} => 20, 20A
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20", "nrzusatz_bis": "" }]} => 20 (wenn nrzusatz_von leerer String ist kann man ihn auch weglassen.)
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "22", "nrzusatz_von": "B", "nrzusatz_bis": "" }]} => 20B, 21, 21A, 21B, 22
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "22", "nrzusatz_von": "B", "nrzusatz_bis": "A" }]} => 20B, 21, 21A, 21B, 22, 22A
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "22", "nrzusatz_von": "B" }]} => 20B, 21, 21A, 21B, 22, 22A,22B
Reihenfolge wenn nr_von = nr_bis
{  "adresse": [{"street_oi": "x11", "nr_von": "20",  "nr_bis": "20", "nrzusatz_von": "B", "nrzusatz_bis": "" }]} => x (keine Zuordnung)

Bezirke

Der Bezirk (= Trägerbezirk) ist die übergeordnete Ebene, wenn zwei Ebenen verfügbar sind. Aus einem oder mehreren Gebieten (= Zellen) werden durch die Zuordnung Gebiet=>Bezirk Bezirke gebildet. Auf dieser Ebene werden keine Zuordnungen zu Gebäuden (Adressen) vorgenommen.

Bezirke abrufen

http://domain/fernsteuerung/bezirk/

Parameter (optional):

nr Nummer(n) der Bezirke
limit Limit
offset Offset
ausgabe Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)

Rückgabe:

[{"nr":"12","name":"","privathaushalte":1,"gewerbebetriebe":2,"abonnenten":10,"starthaus":"1","zustellerhaus":"2","endhaus":"3"},{"nr":"13","name":"","privathaushalte":0,"gewerbebetriebe":0,"abonnenten":0,"starthaus":null,"zustellerhaus":null,"endhaus":null},{"nr":"14","name":"","privathaushalte":0,"gewerbebetriebe":0,"abonnenten":0,"starthaus":null,"zustellerhaus":null,"endhaus":null}]

Optionale Ausgabe wenn in Kundenverwaltung ausgewählt:

privathaushalte, gewerbebetriebe, werbeverweigerer, abonnenten
starthaus, zustellerhaus, endhaus (Gebäude ID (oi))

Bezirke Hinzufügen/Updaten

http://domain/fernsteuerung/bezirk/add_and_update

Parameter:

bezirk Bezirk Parameter
insert true(default) oder false. Nur neue Bezirk werden hinzugefügt
update true(default) oder false. Bestehende Bezirke werden geupdated
ausgabe Name der Ausgabe (optional: default=Aktuelle Ausgabe des Benutzers)

Bezirk Parameter (Achtung: beim Einfügen von mehreren Bezirken muss immer die gleiche Anzahl der Parameter angegeben werden):

nr Bezirknummer
name Bezirkname (optional)
starthaus oi Starthaus (optional)
zustellerhaus oi Zustellerhaus (optional)
endhaus oi Endhaus (optional)

Beispiel:

{
"update": true,
"insert": true, 
"bezirk": [{"nr":"1200","name":"Bezirk 1","starthaus":"1","zustellerhaus":"2","endhaus":"3"},{"nr":"1300","name":"Bezirk 2","starthaus":null,"zustellerhaus":null,"endhaus":null}]
 }

Bezirke löschen

http://domain/fernsteuerung/bezirk/delete

Parameter

nr Nummer des Bezirks/Nummern der Bezirke
ausgabe Name der Ausgabe (optional: defaul=Aktuelle Ausgabe des Benutzers)
{
  nr: ["1","2"]
}

Bezirksdefinition

http://domain/fernsteuerung/bezirk/definition

Parameter (optional)

bezirk Nummer(n) der Bezirke
limit Limit
offset Offset
ausgabe Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)

Rückgabe:

[{"bezirk":"12","gebiet":["1","2","3","4"],"ausgabe":"1234"},{"bezirk":"13","gebiet":["5","6","7","8"],"ausgabe":"1234"}]

Bezirksdefinition Hinzufügen bzw. löschen

http://domain/fernsteuerung/bezirk/add_definition
http://domain/fernsteuerung/bezirk/delete_definition

Parameter:

gebiet Nummern der Gebiete
bezirk Nummer des Bezirks
ausgabe Name der Ausgabe (optional default=Aktuelle Ausgabe des Benutzers)
append Modus beim Hinzufügen (optional default=true) ; mit false wird die Zuordnung ersetzt
all Modus beim Löschen (optional default=false); mit true wird die Zuordnung wird gelöscht
{
  "gebiet": ["1","2","3"],
  "bezirk": "11",
  "ausgabe": "1234" 
}

Bekannte Fehlermeldungen:

{"text":"Ausgabe nicht gefunden","status":500}
{"text":"Kein Gebiet übergeben","status":500}
{"text":"Kein Bezirk übergeben","status":500}
{"text":"Daten wurden nicht übernommen","status":500}

Datenübernahme (individuell konfiguriert)

Nur neue Adressen
http://domain/fernsteuerung/adressen

Alle Verteilbezirke und Zuordnungen
http://domain/fernsteuerung/definition

Neue Adressen und Alle Verteilbezirke sowie Zuordnung
http://domain/fernsteuerung/adressen_definition

Zähllisten

http://domain/fernsteuerung/zaehlliste/<verteilbezirk_nummer>.pdf oder xlsx

Parameter (optional)

|ausgabe| Name der Ausgabe (default=Aktuelle Ausgabe des Benutzers)|


http://127.0.0.1:3000/fernsteuerung/zaehlliste/12.pdf

ClickMap

http://domain/fernsteuerung/click_map/

Parameter:

click_map Nummern der Gebiete
verteilbezirk_nr Nummern der Verteilbezirke
ausgabe Name der Ausgabe (optional: defaul=Aktuelle Ausgabe des Benutzers)
click_map Objekt:
one_bezirk true/false (default: false)
one_bezirk true für einen Verteilbezirk mit/ohne Adresspunkte (Es wird für jeden angegebenen Verteilbezirk eine eigene Clickable Map angelegt)
one_bezirk false für mehrere Verteilbezirk ohne Adresspunkte (Es wird für alle angegebenen Verteilbezirke eine gemeinsame Clickable Map angelegt)
show_adressen true/false (default: false) Adressen werden auch angezeigt (funktioniert nur bei one_bezirk: true)
show_gehfolge true/false (default: false) Aktuellste Gehfolge wird auch angezeigt (funktioniert nur bei one_bezirk: true)
use_once true/false (default: false) Einweg-Link (Link kann nur einmal aufgerufen werden)
{
"click_map": {"show_adressen": true, "one_bezirk": true, "use_once": false}, 
"verteilbezirk_nr": ["B001056", "B001070"]
}

one_bezirk:true Rückgabewert ist ein JSON Array:

[
{"url":"http://domain/klick_karte/20/3d7ca9bc7996ea8e94690170a32820b2","verteilbezirk_nr":"B001056"},
{"url":"http://domain/klick_karte/21/ce8927a1d7ba8ed49f520306e92d112b","verteilbezirk_nr":"B001070"}
]

one_bezirk:false Rückgabewert ist ein JSON Object:

{"url":"http://domain/klick_karte/23/d6aad99591c06d6e242f19ea44933f78"}

Zusie

Zusie Sync

Synchronisation mit Zusie
Es werden die aktuellsten Gehfolgen einer Ausgabe zu Zusie übermittelt, bzw. in Zusie gelöscht.

http://domain/fernsteuerung/zusie/sync/
http://domain/fernsteuerung/zusie/delete/

Optionale Parameter:
ausgabe (default die vom User)
nr Nummern der Verteilbezirke, (default alle)
{"nr": ["B430501004"]}