MultiRoute Go! API-Schnittstelle¶

• MultiRoute Go! API-Schnittstelle
• Gehfolgen-Steuerung
  • Ausgaben
  • Gehfolgen-Status
  • CSV-Export
  • Informationen zu einer Gehfolge (Ausgabe spielt keine Rolle):
  • Download der Trägerdokumente bzw. Info und Details zu einer Gehfolge
  • Gehfolgenberechung starten
    • Für alle Verteilbezirke der (Ausgabe)
    • Für einen Verteilbezirk
    • Abbrechen der Gehfolgenberechung (nur die von User)
  • Beispiele
• Datenaustausch (JSON)
  • Adressen
    • Adressen abrufen
    • Adressen Hinzufügen/Updaten
    • Adressen löschen
  • Abonnenten
    • Abonnenten abrufen
    • Abonnenten Hinzufügen/Updaten
    • Abonnenten löschen
  • Gebiet
    • Gebiete abrufen
    • Gebiet Hinzufügen/Updaten
    • Gebiet löschen
    • Gebietsdefinition
    • Gebietsdefinition hinzufügen bzw. löschen
    • Gebietsdefinition hinzufügen (Mit Street-ID)
  • Bezirke
    • Bezirke abrufen
    • Bezirke Hinzufügen/Updaten
    • Bezirke löschen
    • Bezirksdefinition
    • Bezirksdefinition Hinzufügen bzw. löschen
  • Datenübernahme (individuell konfiguriert)
  • Zähllisten
  • ClickMap
• Zusie
  • Zusie Sync

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)

• Die Waypoints sind die tatsächlichen Gebäudepunkte (rooftop) und enthalten die Adresse als Attribut (in der berechneten Reihenfolge)
• Der Track hat Points und einen Path:
  • Track Points sind die Zugangspunkte auf der Straße und enthalten einen Reihenfolgeindex als Attribut (in der berechneten Reihenfolge)
  • Track Path ist die Streckenlinie aus dem Kartenmaterial
• Die Route hat ebenfalls Points und einen Path:
  • Route Points sind die Zugangspunkte auf der Straße und enthalten die Adresse als Attribut (in der berechneten Reihenfolge)
  • Route Path ist die Linie der Luftlinienverbindung zwischen den Wegpunkten in der berechneten Reihenfolge

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
http://domain/fernsteuerung/gehfolge/3603/all.json -> json

JSON Objekt Beispiele:

Achtung: Die folgenden Keys sind optional:

• nur_abonnenten
• privathaushalte
• gewerbebetriebe
• werbeverweigerer
• abonnenten

Zusammenfassung

{
    "verteilbezirk_nr": "B421902002",
    "verteilbezirk_name": "Landenhausen 2",
    "gehfolge_id": 2727,
    "zustellerhaus": true,
    "fussweg": false,
    "transport": "fuss",
    "zustellerhaus_kfz": false,
    "nur_abonnenten": true,
    "datenstand_osm": "OSM-Datenstand nicht verfügbar",
    "berechnet_am": "27.04.2021 18:52",
    "grenzdistanz": 36,
    "speed": 6.0,
    "ruestzeit": 15,
    "dauer": 0.8222222222222222,
    "steckzeit": 0.7777777777777778,
    "dauer_sekunden": 2960,
    "steckzeit_sekunden": 2800,
    "strecke_im_gebiet": 4934,
    "strecke_gesamt": 5328,
    "hinweg": 197,
    "rueckweg": 197,
    "dauer_hinweg": 0.002777777777777778,
    "dauer_rueckweg": 0.002777777777777778,
    "osrm_schwelldistanz": "30",
    "hauszugangsdistanzen": 0,
    "anzahl_haeuser_mit_hauszugangsdistanz": 0,
    "privathaushalte": 80,
    "gewerbebetriebe": 8,
    "werbeverweigerer": 0,
    "abonnenten": 40,
    "wv_p": 5,
    "wv_gew": 0,
    "wv_p_zeitung": 0,
    "wv_gew_zeitung": 40,
    "hauszugang_suchradius": "30",
    "abladestelle_id": null,
    "ausgabe_name": "GVS_99_Grundstruktur_Abo",
    "ausgabe_stand": null,
    "zusteller_haus": {
        "oi": "24960475",
        "street_oi": "304207",
        "hausnummer": "5",
        "hausnummer_zusatz": "" 
    },
    "hoehenprofil_min": 274,
    "hoehenprofil_max": 306,
    "hoehenprofil_aufstieg": 113,
    "image_path": "/gehfolgens/2727/image_bezirkskarte",
    "bezirkskarte_path": "/gehfolgens/2727/pdf_bezirkskarte.pdf",
    "strassenliste_path": "/gehfolgens/2727/pdf_strassenliste.pdf",
    "haeuserliste_path": "/gehfolgens/2727/pdf_strassenliste_kompakt.pdf" 
}

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
}]

all.json

{
    "verteilbezirk_nr": "B421902002",
    "verteilbezirk_name": "Landenhausen 2",
    "gehfolge_id": 2730,
    "zustellerhaus": false,
    "fussweg": false,
    "transport": "fuss",
    "nur_abonnenten": true,
    "datenstand_osm": "OSM-Datenstand nicht verfügbar",
    "berechnet_am": "29.04.2021 13:03",
    "grenzdistanz": 36,
    "speed": 6.0,
    "ruestzeit": 15,
    "dauer": 1.44,
    "steckzeit": 0.7,
    "dauer_sekunden": 5184,
    "steckzeit_sekunden": 2520,
    "strecke_im_gebiet": 8640,
    "strecke_gesamt": 8640,
    "hinweg": 0,
    "rueckweg": 0,
    "dauer_hinweg": 0,
    "dauer_rueckweg": 0,
    "osrm_schwelldistanz": "30",
    "hauszugangsdistanzen": 8,
    "anzahl_haeuser_mit_hauszugangsdistanz": 1,
    "privathaushalte": 215,
    "gewerbebetriebe": 32,
    "werbeverweigerer": 12,
    "abonnenten": 36,
    "hoehenprofil_min": 274,
    "hoehenprofil_max": 340,
    "hoehenprofil_aufstieg": 200,
    "wv_p": 5,
    "wv_gew": 0,
    "wv_p_zeitung": 0,
    "wv_gew_zeitung": 36,
    "hauszugang_suchradius": "30",
    "abladestelle_id": null,
    "ausgabe_name": "GVS_99_Grundstruktur_Abo",
    "ausgabe_stand": null,
    "image_path": "/gehfolgens/2730/image_bezirkskarte",
    "bezirkskarte_path": "/gehfolgens/2730/pdf_bezirkskarte.pdf",
    "strassenliste_path": "/gehfolgens/2730/pdf_strassenliste.pdf",
    "haeuserliste_path": "/gehfolgens/2730/pdf_strassenliste_kompakt.pdf",
    "route": [{
        "geb_id": "29577122",
        "gehfolge_id": 2730,
        "nr": 1,
        "strasse": "Am Sportzentrum",
        "hausnummer": "7",
        "plz": "36367",
        "ort": "Wartenberg",
        "verteilbezirk_nr": "B421902002",
        "hauszugangs_distanz": null,
        "dauer": null,
        "strecke": null,
        "privathaushalte": 0,
        "gewerbebetriebe": 0,
        "werbeverweigerer": 0,
        "abonnenten": 0,
        "abonnenten_detail": [
            []
        ],
        "bemerkung": "",
        "wv_p": 0,
        "wv_gew": 0,
        "wv_p_zeitung": 0,
        "wv_gew_zeitung": 0,
        "haustyp": null
    },
    ...
    ]
}

Gehfolgenberechung starten¶

Für alle Verteilbezirke der (Ausgabe)¶

http://domain/fernsteuerung/gehfolgen/berechnen

Optionen Parameter: (null setzte den Wert auf Standard)

Beispiel Aufruf:

{
  "verteilbezirk": "B421902002",
  "option": {
    "kfz": true,
    "hauszugangsdistanz": 36,
    "strassen_name": "",
    "starthaus": null,
    "steckzeit_erste": 70,
    "steckzeit_folgende": 20,
    "optimierung": "oneway",
    "geschwindigkeit": 6,
    "geschwindigkeit2": 70,
    "car_profile_fuer_zustellerhaus": false,
    "ruestzeit": 15,
    "nullhaushalte": false,
    "osrm_schwelldistanz": 30,
    "p": true,
    "gew": true
  }
}

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):

Optionale Filter Parameter:

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 Parameter:

{
"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": ["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):

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

{
"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": ["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):

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 Parameter (Achtung: beim Einfügen von mehreren Gebieten muss immer die gleiche Anzahl der Parameter angegeben werden):

Optionen Parameter: (null setzte den Wert auf Standard)

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
}]
 }

Beispiel Optionen Updaten

{
  "ausgabe": "Name der Ausgabe",
  "gebiet": [
    {
      "nr": "B421902002",
      "option": {
        "kfz": false,
        "hauszugangsdistanz": 10,
        "strassen_name": null,
        "starthaus": null,
        "steckzeit_erste": 70,
        "steckzeit_folgende": 25,
        "optimierung": "roundtrip",
        "geschwindigkeit": 12,
        "geschwindigkeit2": 50,
        "car_profile_fuer_zustellerhaus": true,
        "ruestzeit": 5,
        "nullhaushalte": true,
        "osrm_schwelldistanz": "20" 
      }
    }
  ]
}

Beispiel Zustellerhaus mit Straßenabschnitts-ID

{
  "gebiet": [
    {
      "nr": "B421902002",
      "zustellerhaus": {
        "street_oi": "304207",
        "hausnummer": "7",
        "hausnummer_zusatz": "" 
      }
    }
  ]
}

Gebiet löschen¶

http://domain/fernsteuerung/gebiet/delete

Parameter:

{
  nr: ["1","2"]
}

Gebietsdefinition¶

http://domain/fernsteuerung/gebiet/definition

Parameter (optional):

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": ["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": [{"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):

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 Parameter (Achtung: beim Einfügen von mehreren Bezirken muss immer die gleiche Anzahl der Parameter angegeben werden):

Start- Zusteller- Endhaus als Objekt (r2417) |street_oi|Straßenabschnitts-ID (required)| |hausnummer|Hausnummer (required)| |hausnummer_zusatz|Hausnummer Zusatz (required)|
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: ["1","2"]
}

Bezirksdefinition¶

http://domain/fernsteuerung/bezirk/definition

Parameter (optional)

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": ["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": {"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/

{"nr": ["B430501004"]}