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…“) |
|||
| 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</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= | ||
| + | |||
| + | 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</code> | ||
| + | |||
| + | <b>Request</b> <code>https://services.infeo.at/aloa/api/streets/cities</code> | ||
| + | |||
| + | <b>Response</b> | ||
| + | <pre> | ||
| + | [ | ||
| + | "Linz" | ||
| + | ] | ||
| + | </pre> | ||
| + | |||
| + | =GetStreets= | ||
| + | |||
| + | Dieser Request fragt anhand eines übermittelten Städtenamens alle Straßennamen in dieser Stadt ab und übermittelt diese als einzelne Textelemente. | ||
| + | |||
| + | Als Zusatzparameter kann ein Suchbegriff übermittelt werden, der die Ergebnismenge einschränkt. | ||
| + | |||
| + | <b>POST</b> <code>https://services.infeo.at/aloa/api/streets/</code> | ||
| + | * searchTerm (string) optional um Straßennamen zu filtern | ||
| + | * zipcode (string) optional um die Beziehung zur Stadt zu definieren | ||
| + | * city (string) optional um die Beziehung zur Stadt zu definieren | ||
| + | |||
| + | <b>Request</b> <code>https://services.infeo.at/aloa/api/streets?searchTerm=Ober&zipcode=4020&city=Linz</code> | ||
| + | |||
| + | <b>Response</b> | ||
| + | <pre> | ||
| + | [ | ||
| + | "Obere Donaulände", | ||
| + | "Oberfeldstraße", | ||
| + | "Robert-Koch-Straße" | ||
| + | ] | ||
| + | </pre> | ||
Version vom 12. September 2019, 17:45 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
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
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
Request https://services.infeo.at/aloa/api/streets/cities
Response
[
"Linz"
]
GetStreets
Dieser Request fragt anhand eines übermittelten Städtenamens alle Straßennamen in dieser Stadt ab und übermittelt diese als einzelne Textelemente.
Als Zusatzparameter kann ein Suchbegriff übermittelt werden, der die Ergebnismenge einschränkt.
POST https://services.infeo.at/aloa/api/streets/
- searchTerm (string) optional um Straßennamen zu filtern
- zipcode (string) optional um die Beziehung zur Stadt zu definieren
- city (string) optional um die Beziehung zur Stadt zu definieren
Request https://services.infeo.at/aloa/api/streets?searchTerm=Ober&zipcode=4020&city=Linz
Response
[
"Obere Donaulände",
"Oberfeldstraße",
"Robert-Koch-Straße"
]
