Schnittstelle Streets: Unterschied zwischen den Versionen
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
Zeile 7: | Zeile 7: | ||
Externen Anwendungen stehen die folgenden WebServices zur Verfügung sofern der Client korrekt über getsecuretoken angemeldet wurde. | Externen Anwendungen stehen die folgenden WebServices zur Verfügung sofern der Client korrekt über getsecuretoken angemeldet wurde. | ||
− | + | =GetCities= | |
Dieser Request fragt alle Städtenamen aus der Datenbank ab und übermittelt diese als einzelne Textelemente. | Dieser Request fragt alle Städtenamen aus der Datenbank ab und übermittelt diese als einzelne Textelemente. | ||
<b>GET</b> <code>https://services.infeo.at/aloa/api/streets/cities</code> | <b>GET</b> <code>https://services.infeo.at/aloa/api/streets/cities</code> | ||
+ | |||
+ | <b>Request</b> <code>https://services.infeo.at/aloa/api/streets/cities</code> | ||
<b>Response</b> | <b>Response</b> | ||
− | < | + | <pre> |
[ | [ | ||
"Linz" | "Linz" | ||
] | ] | ||
− | </code> | + | </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> |
Aktuelle Version vom 12. September 2019, 17:32 Uhr
Das ALOA system verfügt über eine eigene Straßentabelle mit standardisierten Straßenbezeichnungen in Verbindung mit Postleitzahlen und Ortsnamen.
Die Quelle für diese Straßentabelle kann unterschiedlich sein, z.B. die Statistik-Austria-Straßenverzeichnisse oder ähnliche Listen aus anderen Ländern.
Mit der Schnittstelle "Streets" können diese Ortsnamen und Straßenlisten abgefragt werden um beispielsweise in Formularen die standardisierte Befüllung mit gleicher Schreibweise zu ermöglichen.
Externen Anwendungen stehen die folgenden WebServices zur Verfügung sofern der Client korrekt über getsecuretoken angemeldet wurde.
GetCities
Dieser Request fragt alle Städtenamen aus der Datenbank ab und übermittelt diese als einzelne Textelemente.
GET https://services.infeo.at/aloa/api/streets/cities
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" ]