Schnittstelle Sperrmüll: Unterschied zwischen den Versionen
(Die Seite wurde neu angelegt: „Die Schnittstelle für das Sperrmüllmodul bietet Funktionen zum Abfragen von Tourdaten, sowie zum Importieren und Exportieren von Auftragsdaten in das ALOA sy…“) |
|||
| (4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 3: | Zeile 3: | ||
Die folgenden WebService-Calls stehen externen Anwendungen zur Verfügung, sofern sie über den WebService angemeldet sind. | Die folgenden WebService-Calls stehen externen Anwendungen zur Verfügung, sofern sie über den WebService angemeldet sind. | ||
| − | ===GetTours=== | + | =GetZones= |
| + | |||
| + | Dieser Request fragt alle Abfuhrzonen (Abfuhrgebiete) aus der Datenbank ab und übermittelt diese als einzelne Objekte. | ||
| + | |||
| + | <b>GET</b> <code>https://services.infeo.at/aloa/api/bulky-waste-zones/proxy</code> | ||
| + | |||
| + | <b>Request</b> <code>https://services.infeo.at/aloa/api/bulky-waste-zones/proxy</code> | ||
| + | |||
| + | <b>Response</b> | ||
| + | <pre> | ||
| + | [ | ||
| + | { | ||
| + | "id": 1, | ||
| + | "lastChange": "2019-09-12T18:45:23+02:00", | ||
| + | "name": "Amstetten" | ||
| + | }, | ||
| + | { | ||
| + | "id": 2, | ||
| + | "lastChange": "2019-09-12T18:45:23+02:00", | ||
| + | "name": "Mauer/Neufurth" | ||
| + | } | ||
| + | ] | ||
| + | </pre> | ||
| + | |||
| + | =GetTours= | ||
| + | |||
| + | In einem weiteren Schritt können nun für diese Abfuhrzone die einzelnen Touren (quasi Abholtermine) abgefragt werden. | ||
| + | |||
| + | Dieser Request fragt alle Abfuhrzonen (bzw. Touren) aus der Datenbank ab und übermittelt diese als einzelne Objekte. | ||
| + | |||
| + | <b>GET</b> <code>https://services.infeo.at/aloa/api/bulky-waste-tours/for-zone</code> | ||
| + | |||
| + | <b>Request</b> <code>https://services.infeo.at/aloa/api/bulky-waste-tours/for-zone?zone=1</code> | ||
| + | * zone (int32) die ID der Zone | ||
| + | |||
| + | <b>Response</b> | ||
| + | <pre> | ||
| + | [ | ||
| + | { | ||
| + | "id": 1, | ||
| + | "lastChange": "2019-09-12T18:47:30+02:00", | ||
| + | "date": "2019-09-30T00:00:00+02:00", | ||
| + | "zoneId": 1, | ||
| + | }, | ||
| + | { | ||
| + | "id": 2, | ||
| + | "lastChange": "2019-09-12T18:47:37+02:00", | ||
| + | "date": "2019-10-01T00:00:00+02:00", | ||
| + | "zoneId": 1, | ||
| + | } | ||
| + | ] | ||
| + | </pre> | ||
| + | |||
| + | =Import= | ||
| + | |||
| + | Dieser Request übermittelt einen Sperrmüllauftrag und speichert diesen in der Datenbank ab | ||
| + | |||
| + | <b>POST</b> <code>https://services.infeo.at/aloa/api/bulky-waste-orders/import</code> | ||
| + | * Die Daten werden im Body als JSON-Objekt mit folgenden Feldern übermittelt | ||
| + | * street (string) Name der Straße | ||
| + | * housenumber (string) Hausnummer | ||
| + | * zipcode (string) PLZ | ||
| + | * city (string) Ort/Gemeinde | ||
| + | * description (string) Beschreibung mit Auftragsinformationen | ||
| + | * customer (string) Kundenbezeichnung (z.B. Name des Antragstellers) | ||
| + | * tourId (int32) optional, ID der ausgewählten Tour | ||
| + | |||
| + | <b>Request</b> <code>https://services.infeo.at/aloa/api/bulky-waste-orders/import</code> | ||
| + | <pre> | ||
| + | { | ||
| + | "street": "Hauptplatz", | ||
| + | "housenumber": "15", | ||
| + | "zipcode": "3300", | ||
| + | "city": "Amstetten", | ||
| + | "description": "1x Badewanne, 2x Fahrrad", | ||
| + | "customer": "Peter Müller, Tel. 0664-1512512", | ||
| + | "tourId": 1 | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | <b>Response</b> | ||
| + | Als Response wird lediglich ein leerer HTTP-200 gesendet | ||
Aktuelle Version vom 12. September 2019, 18:03 Uhr
Die Schnittstelle für das Sperrmüllmodul bietet Funktionen zum Abfragen von Tourdaten, sowie zum Importieren und Exportieren von Auftragsdaten in das ALOA system.
Die folgenden WebService-Calls stehen externen Anwendungen zur Verfügung, sofern sie über den WebService angemeldet sind.
GetZones
Dieser Request fragt alle Abfuhrzonen (Abfuhrgebiete) aus der Datenbank ab und übermittelt diese als einzelne Objekte.
GET https://services.infeo.at/aloa/api/bulky-waste-zones/proxy
Request https://services.infeo.at/aloa/api/bulky-waste-zones/proxy
Response
[
{
"id": 1,
"lastChange": "2019-09-12T18:45:23+02:00",
"name": "Amstetten"
},
{
"id": 2,
"lastChange": "2019-09-12T18:45:23+02:00",
"name": "Mauer/Neufurth"
}
]
GetTours
In einem weiteren Schritt können nun für diese Abfuhrzone die einzelnen Touren (quasi Abholtermine) abgefragt werden.
Dieser Request fragt alle Abfuhrzonen (bzw. Touren) aus der Datenbank ab und übermittelt diese als einzelne Objekte.
GET https://services.infeo.at/aloa/api/bulky-waste-tours/for-zone
Request https://services.infeo.at/aloa/api/bulky-waste-tours/for-zone?zone=1
- zone (int32) die ID der Zone
Response
[
{
"id": 1,
"lastChange": "2019-09-12T18:47:30+02:00",
"date": "2019-09-30T00:00:00+02:00",
"zoneId": 1,
},
{
"id": 2,
"lastChange": "2019-09-12T18:47:37+02:00",
"date": "2019-10-01T00:00:00+02:00",
"zoneId": 1,
}
]
Import
Dieser Request übermittelt einen Sperrmüllauftrag und speichert diesen in der Datenbank ab
POST https://services.infeo.at/aloa/api/bulky-waste-orders/import
- Die Daten werden im Body als JSON-Objekt mit folgenden Feldern übermittelt
- street (string) Name der Straße
- housenumber (string) Hausnummer
- zipcode (string) PLZ
- city (string) Ort/Gemeinde
- description (string) Beschreibung mit Auftragsinformationen
- customer (string) Kundenbezeichnung (z.B. Name des Antragstellers)
- tourId (int32) optional, ID der ausgewählten Tour
Request https://services.infeo.at/aloa/api/bulky-waste-orders/import
{
"street": "Hauptplatz",
"housenumber": "15",
"zipcode": "3300",
"city": "Amstetten",
"description": "1x Badewanne, 2x Fahrrad",
"customer": "Peter Müller, Tel. 0664-1512512",
"tourId": 1
}
Response Als Response wird lediglich ein leerer HTTP-200 gesendet
