Verwenden der Geoportal-REST-API
In diesem Thema
Die REST-API im Geoportal
Mit der Geoportal-REST-API können die einzelnen Metadatensätze im Geoportal-Katalog einer eindeutigen URL mit Webzugriff zugewiesen werden. Der Geoportal-Katalog kann auch über URLs mithilfe der REST-Syntax abgerufen werden. Der Zugriff auf einzelne Metadatendokumente mithilfe ihrer REST-URLs oder auf Gruppen von Dokumenten, die bestimmten Suchkriterien entsprechen, mithilfe einer Such-URL im REST-Format ist beim Suchen, Anzeigen und Freigeben von Datensätzen ausgesprochen praktisch. Beispielsweise können Sie die URL an ein Metadatendokument oder eine Suche an Kollegen senden. Diese können die Ressourcen dann ohne Geoportal nutzen und müssen keine eigene Suche durchführen. Durch Einbindung der URLs in andere Webseiten oder in das Content-Management-System Ihres Unternehmens erhalten Benutzer Links zu Ressourcen. Auch hier muss keine eigene Suche durchgeführt werden. Außerdem erleichtert die REST-API die Einbindung externer Anwendungen, wie unten erläutert.
Um die REST-URL eines einzelnen Metadatensatzes anzuzeigen, klicken Sie in einer Liste mit Suchergebnissen auf den Link "Details" des jeweiligen Datensatzes, und blättern Sie bis zum Ende der Seite mit den Details. Die URL wird ähnlich formatiert wie im folgenden Beispiel. Die hier kursiv gedruckte GUID wird dabei durch eine eindeutige GUID ersetzt.
/geoportal/rest/document?f=html&id=%7BF6B6CCA6-9013-4018-9FFE-5F8163E27FBD%7D
Sollen nach Durchführung einer Suche anhand von Kriterien die REST-Suchergebnisse angezeigt werden, blättern Sie zum Ende der Seite mit den Geoportal-Suchergebnissen. Dort befinden sich Links, um die Anzeige in den REST-Formaten GEORSS, ATOM, HTML, FRAGMENT, KML oder JSON anzuzeigen. Die einzelnen REST-Formate werden in der Tabelle unten mit jeweils einem Verwendungsbeispiel in einer externen Anwendung erläutert.
| REST-Format | Beschreibung | Externe Anwendung |
|---|---|---|
GEORSS | Ergebnisse werden im Format GEORSS angezeigt. So können Benutzer auch einen RSS-Feed für Datensätze abonnieren, die Suchkriterien entsprechen. | RSS-Reader wie Microsoft® Outlook 2007, Microsoft® Internet Explorer und Mozilla Firefox |
ATOM | Ergebnisse werden im Format ATOM angezeigt, einem weiteren Standard zum Abrufen von Syndication-Feeds, mit dem Benutzer Aktualisierungen abonnieren können. | RSS-Reader wie Microsoft® Outlook 2007, Microsoft® Internet Explorer und Mozilla Firefox |
HTML | Ergebnisse werden als vollständiges HTML-Dokument formatiert. | Content-Management-Systeme und Wikis wie Microsoft® SharePoint, Joomla!™ und JSPWiki |
FRAGMENT | Ergebnisse werden als Fragment des HTML-Dokuments formatiert, allerdings ohne die Tags <html>,<head>,<title> oder <body>. | Content-Management-Systeme und Wikis wie Microsoft® SharePoint, Joomla!™ und JSPWiki |
KML | Ergebnisse werden im KML-Format formatiert, um Suchergebnisse in Web-Mapping-Anwendungen anzeigen zu können. | Mapping-Anwendungen sind z. B. Google™ Maps, Google™ Earth, Microsoft® Virtual Earth. |
JSON | Ergebnisse werden im JSON-Format formatiert. | Benutzerdefinierte Anwendungen wie Entwicklungs-Widgets für Microsoft® Silverlight |
Mit der REST-API können Benutzer mithilfe der Funktion OpenSearch das Geoportal zudem direkt in ihrem Browser durchsuchen. Sie haben unendlich viele Möglichkeiten, Ihren Geoportal-Katalog in andere Anwendungen einzubinden und können Ihren Metadatenkatalog damit auch entsprechend auffällig positionieren.