Back to Home

Regionen

@deprecated Dieser Typ wird in zukünftigen Versionen der Falk POI API entfernt. Stattdessen verwende bitte die API-Schnittstellen für Destinationen.

Dieses Dokument beschreibt Schnittstellen mit Bezug auf Regionen.

Neu angelegte POIs werden automatisch den verfügbaren Regionen hinzugefügt. Zum einen werden administrative Regionen über das Reverse Geocoding ermittelt. Touristische Regionen werden anhand der Bounding Box zugeordnet.

Inhaltsverzeichnis

Abfragen der Top-Regionen

Es können alle Regionen abgefragt werden, die als Parent die Welt haben.

User Story Ein User kann die Topregionen abfragen
HTTP GET
URL http://api.123poi.com/data/poi/api/region/0/

Abfragen der Daten einer Region

User Story Ein User kann die Daten einer Region abfragen
HTTP GET
URL http://api.123poi.com/data/poi/api/region/$RegionID$/

Man erhält die Daten einer Region. Dazu zählen die Parent Regionen, die assoziierten Regionen sowie verlinkte Kinder. Außerdem erhälte man den Typ, die Id sowie den lokalisierten Namen der Region.

Beispiel:

GET http://api.123poi.com/data/poi/api/region/4/
    
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:exif="http://api.123poi.com/exif/" xmlns:poi="http://api.123poi.com/poi/"
           xmlns:media="http://search.yahoo.com/mrss/" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/">
       <openSearch:totalResults>0</openSearch:totalResults>
       <openSearch:startIndex>0</openSearch:startIndex>
       <openSearch:itemsPerPage>0</openSearch:itemsPerPage>
       <openSearch:Query role="request" poi:access="VISIBLE" />
       <updated>2010-07-26T09:46:16.799Z</updated>
       <link href="http://api.123poi.com/data/poi/api/region/4" rel="self" />
       <title type="text">Find region</title><subtitle type="text" />
       <id>http://api.123poi.com/data/poi/api/region/4</id>
       <author>
         <name>Falk POI API</name>
       </author>
       <entry>
         <id>http://api.123poi.com/data/poi/api/region/4</id>
         <title type="text">Stuttgart</title>
         <summary type="text">Id: 4, Type: REGION, Parents: Baden-Württemberg, Deutschland, Europa, 
           BoundingBox: 48.8442134882954, 9.07837282205175, 48.7189338627092, 9.26966752084672</summary>
         <content type="application/xml">
           <falkgeo:region xmlns:falkgeo="http://api.123poi.com/geo/">
             <falkgeo:id>4</geo:id>
             <falkgeo:title>Stuttgart</falkgeo:title>
             <falkgeo:regionType>REGION</falkgeo:regionType>
             <falkgeo:boundingBox>
               <falkgeo:northwest>
                 <falkgeo:lat>48.8442134882954</falkgeo:lat>
                 <falkgeo:lon>9.07837282205175</falkgeo:lon>
               </falkgeo:northwest>
               <falkgeo:southeast>
                 <falkgeo:lat>48.7189338627092</falkgeo:lat>
                 <falkgeo:lon>9.26966752084672</falkgeo:lon>
               </falkgeo:southeast>
             </falkgeo:boundingBox>
             <falkgeo:parents>
               <falkgeo:parent>
                 <falkgeo:id>1127</falkgeo:id>
                 <falkgeo:title>Baden-Württemberg</falkgeo:title>
                 <falkgeo:regionType>ADMIN_STATE</falkgeo:regionType>
               </falkgeo:parent>
               <falkgeo:parent>
                 <falkgeo:id>2</falkgeo:id>
                 <falkgeo:title>Deutschland</falkgeo:title>
                 <falkgeo:regionType>ADMIN_COUNTRY</falkgeo:regionType>
               </falkgeo:parent>
               <falkgeo:parent>
                 <falkgeo:id>1</falkgeo:id>
                 <falkgeo:title>Europa</falkgeo:title>
                 <falkgeo:regionType>ADMIN_CONTINENT</falkgeo:regionType>
               </falkgeo:parent>
             </falkgeo:parents>
             <falkgeo:associatedRegions />
           </falkgeo:region>
         </content>
       </entry>
     </feed>

Abfragen der POIs einer Region

User Story Ein User kann für Regionen alle enthaltenen POIs abfragen
HTTP GET
URL http://api.123poi.com/data/poi/api/all/?region=RegionId

Für die Abfrage von POIs einer Region gelten die selben Regeln der Sortierung wie für die anderen Abfragen, die eine Menge von POIs liefern.

 

User Story Ein User kann für Regionen alle POIs eines bestimmten Benutzers abfragen
HTTP GET
URL http://api.123poi.com/data/poi/projection/user/UserID/?region=RegionId
User Story Ein in User kann alle POIs eines Folders abfragen, die in einer bestimmten Region liegen.
HTTP GET
URL http://api.123poi.com/data/poi/api/user/UserID/folder/FolderID?region=RegionId

Abfragen der Regionen Statistik

Für allgemeine Suchen, für User-POIs und POIs in Foldern kann die Regionen Statistik abgefragt werden. Es werden die Regionentitel zusammen mit der Anzahl der POIs die in dieser Region liegen zurückgeliefert.

User Story Ein User kann die Regionen Statistik einer Suchabfrage abrufen.
HTTP GET
URL http://api.123poi.com/data/poi/api/all/?filter=region&search=Suchbegriff
User Story Ein User kann die Regionen Statistik der POIs eines Benutzers abfragen.
HTTP GET
URL http://api.123poi.com/data/poi/projection/user/UserID/?filter=region
User Story Ein User kann die Regionen Statistik der POIs eines Folders abfragen.
HTTP GET
URL http://api.123poi.com/data/poi/api/user/UserID/folder/FolderID?filter=region

Abfragen der Regionen eines einzelnen Pois

Für einen einzelnen Poi können die Regionen abgefragt werden, denen dieser Poi zugeordnet ist.

User Story Ein User kann die Regionen eines einzelnen Pois abfragen.
HTTP GET
URL http://api.123poi.com/data/poi/api/poi/PoiID/?filter=region

Ändern der Regionen eines POIs

Die automatisch zugeordneten Regionen eines POIs können nur von privilegierten Benutzern geändert werden. Wird anschließend der POI wieder von einem anderen Benutzer geändert, so dass sich der Geocode im Basepoi ändert so wird wieder eine automatische Zuordnung zu den vorhandenen Regionen durchgeführt und eine eventuelle Anpassung durch einen Redakteur geht verloren.

Beispiel-XML zum Ändern der Regionen:

PUT http://api.123poi.com/data/poi/api/poi/6587945/
    
    <entry xmlns="http://www.w3.org/2005/Atom" xmlns:poi="http://api.123poi.com/poi/" xmlns:falkgeo="http://api.123poi.com/geo/"
      xmlns:data="http://api.123poi.com/data/" xmlns:falkmedia="http://api.123poi.com/media/" xmlns:user="http://api.123poi.com/user/">
      <title type="text">Zeitgeschichtliches Forum Leipzig</title>
      <content type="application/atom+xml">
        <poi:poi>
          <falkgeo:regions>   
            <falkgeo:region>
              <falkgeo:id>171</falkgeo:id>
              <falkgeo:title>Schwäbische Alb</falkgeo:title>
            </falkgeo:region>
            <falkgeo:region>
              <falkgeo:id>1127</falkgeo:id>
              <falkgeo:title>Baden-Württemberg</falkgeo:title>
              <falkgeo:regionType>ADMIN_STATE</falkgeo:regionType>
            </falkgeo:region>
              <falkgeo:region>
              <falkgeo:id>179</falkgeo:id>
              <falkgeo:title>Ulm</falkgeo:title>
            </falkgeo:region>
          </falkgeo:regions>
        </poi:poi>
      </content>
    </entry>