Schnittstelle Sperrmüll: Unterschied zwischen den Versionen

Aus awm web Hilfe
Wechseln zu: Navigation, Suche
(GetTours)
Zeile 28: Zeile 28:
  
 
=GetTours=
 
=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.
 
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>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/streets/cities</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>
 
<b>Response</b>
 
<pre>
 
<pre>
 
[
 
[
     "Linz"
+
     {
 +
        "id": 1,
 +
        "lastChange": "2019-09-12T18:47:30+02:00",
 +
        "date": "2019-09-30T00:00:00+02:00",
 +
        "zoneId": 1,
 +
        "zoneName": null,
 +
    },
 +
    {
 +
        "id": 2,
 +
        "lastChange": "2019-09-12T18:47:37+02:00",
 +
        "date": "2019-10-01T00:00:00+02:00",
 +
        "zoneId": 1,
 +
        "zoneName": null,
 +
    }
 
]
 
]
 
</pre>
 
</pre>

Version vom 12. September 2019, 17:49 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,
        "zoneName": null,
    },
    {
        "id": 2,
        "lastChange": "2019-09-12T18:47:37+02:00",
        "date": "2019-10-01T00:00:00+02:00",
        "zoneId": 1,
        "zoneName": null,
    }
]

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