Capabilities GET-Anforderung

Anhand einer GET-Anforderung an den Capabilities-Dienst werden Informationen zu Folgendem zurückgegeben:
  • unterstützte Dienste
  • verfügbare Geocoding-Engines
  • unterstützte Länder
  • unterstützte Vorgänge und verknüpfte erforderliche und optionale Eingaben
  • benutzerdefinierte Felder

Basis-URI

http://<server>:<port>/rest/GlobalGeocode/capabilities.[content type]?[query parameters]

Dabei gilt:

.[content type] angibt, dass der angegebene Inhaltstyp standardmäßig verwendet wird. Optional:

JSON: Der standardmäßige Inhaltstyp ist JSON, es sei denn, er wird durch eine HTTP-Inhaltsaushandlung ersetzt.

XML: Der standardmäßige Inhaltstyp ist XML, es sei denn, er wird durch eine HTTP-Inhaltsaushandlung ersetzt.

[query parameters] werden im folgenden Abschnitt beschrieben.

Abfrageparameter

Es gibt mehrere Optionen für den Typ der zurückgegebenen Informationen, die auf den eingegebenen Abfrageparametern basieren:
  • Einen Ländercode einschließen, um die Capabilities für das angegebene Land abzurufen;
  • Einen Ländercode und einen Vorgang einschließen, um die Beschreibung für diesen Vorgang abzurufen; oder
  • Alle Abfrageparameter ausschließen, um die Capabilities für alle Länder abzurufen.

Die Abfrageparameter für den Capabilities-Dienst sind in der folgenden Tabelle definiert.

Name Beschreibung
country Name des Landes im ISO 3166-1-Format Alpha-2 oder Alpha-3 oder ein gebräuchlicher Name des Landes, wie die Vereinigten Staaten.
operation Typ des Geocode-Dienstvorgangs. Zur Auswahl stehen:
  • geocode
  • reverseGeocode
  • interactive
  • keyLookup