Back to Home
Destinationen
Dieses Dokument beschreibt Operationen mit primärem Bezug auf Destinationen.
Inhaltsverzeichnis
Abfragen von Destinationen und TravelInfos
Zum Abfragen von Destinationen und TravelInfos gibt es grundsätzlich die beiden URLs
wo jeweils eine DestinationId bzw. eine TravelInfoId angegeben werden muss. Die zurückgegebene Information unterschiedet sich je nach URL und Filter Parameter.
Die folgenden Werte für den Filter Parameter sind möglich, wobei nicht alle Werte von beiden URLs unterstützt werden: DESTINATION, TRAVELINFO, BREADCRUMB, PARENT, CHILDREN, DESCENDANTS, INTERESTINGFOR, CONTAINEDIN, WITHIN, POI, TRAVELPOI und EVENT. Der Vorgabewert für die erste URL ist DESTINATION und TRAVELINFO für die zweite URL.
Bei Rückgabe von TravelInfos kann die Ergebnismenge zudem über den bookseries Parameter auf einzelne oder einige Buchserien eingeschränkt werden.
Granulierung
Den Pfad kann man sich hier zusammenstellen:
">http://api.mairdumont.com/data/granulation/GranulierungsTreeSingleDestination.html
Es wird empfohlen bei allen Anfragen eine Granulierung nur mit den benötigten Feldern mitzugeben. Je weniger Felder abgefragt werden, umso schneller können Abfragen beantwortet werden. Gerade "media" und "mediastatistic" sollten weggelassen werden, wenn sie für die Ausgabe nicht benötigt werden.
Sortierung
Über den Request-Parameter "sort" kann die gewünschte Sortierung gewählt werden. Über den Request-Parameter "sortdir" kann zwischen aufsteigender und absteigender Sortierung gewählt werden.
| alpha |
Alphabetische Sortierung nach lokalisiertem Destinationsnamen. |
| popularity |
Sortierung nach Beliebtheit. Die Beliebtheit berechnet sich aus den verfügbaren Informationen zur Destination, der Bevölkerungsanzahl und der Anzahl der Abrufe der Destination. |
| id |
Sortierung nach ID. Es wird nur die aufsteigende Sortierung unterstützt. |
| sales |
Sortierung nach den aufsummierten Verkaufszahlen der direkten und enthaltenen Produkte. Hier werden z.B. die Verkaufszahlen für einen Produkt, das an der Destination "Hamburg" hängt, auch für die Destinationen "Deutschland" und "Europa" gezählt. |
| destsales |
Sortierung nach den aufsummierten Verkaufszahlen der direkten Produkte. Es werden nur Verkaufszahlen von Produkten berücksichtigt, die direkt der Destination zugeordnet sind. |
Abfragen einer Destination
Es kommt Information über eine einzelne Destination zurück.
Abfragen der Unterdestinationen (Kinder) einer Destination
Es kommt eine Liste mit Informationen über Destinationen zurück. Die Liste ist leer, wenn die abgefragte Destination keine Nachkommen verfügt.
Über den Parameter "citiesInPolygon=true" werden zusätzlich Städte-Destinationen im Polygon gefunden, falls für eine touristische Region (TravelRegion) mit Polygon angefragt wird.
Abfragen von enthaltenen Destinationen (Kinder + containedIn) einer Destination
Es kommt eine Liste mit Informationen über Destinationen zurück. Es werden alle Kinder der Destination und alle Destinationen die mit einer ContainedIn-Relation zu der Destinationen in Beziehung stehen zurückgeliefert. Die Liste ist leer, wenn keine passenden Destinationen gefunden werden.
Über den Parameter "citiesInPolygon=true" werden zusätzlich Städte-Destinationen im Polygon gefunden, falls für eine touristische Region (TravelRegion) mit Polygon angefragt wird.
Abfragen von untergeordneten Destinationen (Kinder, Enkel, usw.) einer Destination
Es kommt eine Liste mit Informationen über Destinationen zurück. Es werden alle Kinder, Enkel, Urenkel, usw. der Destination zurückgeliefert. So sind die Destinationen Baden-Württemberg und Stuttgart der Destination Deutschland untergeordnet. Die Liste ist leer, wenn keine passenden Destinationen gefunden wurden.
Über den Parameter "citiesInPolygon=true" werden zusätzlich Städte-Destinationen im Polygon gefunden, falls für eine touristische Region (TravelRegion) mit Polygon angefragt wird.
Abfragen der wichtigen Destinationen
Es kommt eine Liste mit allen als wichtig markierten Destinationen zurück, die dem angegebenen Destination untergeordnet sind. Die Liste ist leer, wenn die abgefragte Destination keine wichtigen Nachkommen hat. Die Liste kann über 'itemsPerPage' begrenzt werden.
Abfragen von Destinationen, für die eine Destination interessant ist
Es kommt eine Liste mit Informationen über Destinationen zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten Destinationen verfügt.
Abfragen von interessanten Destinationen für eine Destination
Es kommt eine Liste mit Informationen über Destinationen zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten Destinationen verfügt.
Es kommt eine Liste mit Informationen über Destinationen zurück. Werden keine interessanten Destinationen gefunden, werden die Destinationen mit Reisebezug in der Nähe zurückgeliefert. Anhand des Attributes destinationRelationType lässt sich erkennen, ob es sich um interessante Destinationen handelt oder um Destinationen mit Reisebezug in der Nähe.
Abfragen von nahgelegene Destinationen mit Reisebezug für eine Destination
Es kommt eine Liste mit Informationen über Destinationen zurück. Die Liste enthält nur Destinationen die als Reise relevant eingestuft sind.
Abfragen von enthaltenen Destinationen für eine Destination
Es kommt eine Liste mit Informationen über Destinationen (nur Travel-Regions) zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten Destinationen verfügt, oder wenn die Travel-region keine, für den Anfragenden; sichtbasren TravelInfo-Objekte hat.
Abfragen von Städten einer touristischen Region
Es kommt eine Liste mit Informationen über Destination zurück. Die Liste ist leer, falls die abgefragte Destination über kein Polygon verfügt.
Es kommt eine Liste mit Reiseinformationen zurück. Die Liste ist leer, wenn keine sichtbaren Reiseinformationen gefunden wurden.
Abfragen der übergeordneten Destinationen (breadcrumb)
Es kommt eine Liste mit Listen von abgespeckten Destinationen zurück. Die erste Liste enthält den Pfad über die Eltern-Destination. Die folgenden Listen enthalten die alternativen Routen.
Abfragen der Statistik einer Destination
Es kommt Statistik Information über eine einzelne Destination für aktuellen Customer zurück. Die Statistk ist Erstellung für sowie Anzahl Destination Pois, Anzahl Highlights, Anzahl Destination POIs pro Kategorie, ob die Premium-POIs vorhanden ist, ob die BestOf-Touren vorhanden ist und Liste mit TravelInfo Sub Text Types usw. Einige Statistiken hängen von der übergebenen Sprache ab, z.B. die Anzahl der Unter-Destinationen sowie die Anzahl der enthaltenen Destinationen.
Einschränkung
Die Statistik wird aus Performancegründen kundenspezifisch erstellt und ist nur unter gesonderten Konditionen erhältlich.
Abfragen der Facetten einer Destination
Über den Parameter "facet" können die Facetten zur Ergebnismenge abgefragt werden. Aktuell unterstützt wird die Facette "attribution".
Suchen
Suche nach Destinationen
Destinationen vom Type "TravelRegion" werden nur zurückgegeben, wenn für den Lizenznehmer sichtbare Travelinfo vorhanden sind.
Suche nach Destinationen in einer BoundingBox
Destinationen vom Type "TravelRegion" werden nur zurückgegeben, wenn für den Lizenznehmer sichtbare Travelinfo vorhanden sind.
Suche nach Destinationen mit bestimmten Typ
Über den Parameter "destinationTypes" werden alle Destinationen ausgeblendet, welche nicht den angegebenen Destination-Typen entsprechen. Mehrere Typen können über Komma getrennt angegeben werden.
Suche nach Destinationen mit Reiseführertexten aus Buchserien
Über den Parameter "bookseries" werden alle Destinationen ausgeblendet, welche nicht über Reiseführertexte der angegebenen Buchserien verfügen. Mehrere Buchserien können über Komma getrennt angegeben werden. Als Destination mit Reiseführertexten gilt z.B. die Reise-Region "Mallorca - Der Süden" aus dem Reiseführer "Mallorca".
Suche nach Destinationen mit Reiseführern aus Buchserien
Über den Parameter "bookinfo=true" werden alle Destinationen ausgeblendet, welche nicht als Reiseführer-Destination markiert sind. Dabei wird automatisch auf die für den Customer sichtbaren Buchserien eingeschränkt. Über den Parameter "bookseries" kann zusätzlich auf die Reiseführer der angegebenen Buchserien eingeschränkt werden. Als Reiseführer-Destination gilt z.B. die Stadt Rom mit dem hinterlegten Reiseführer gleichen Namens.
Suche nach Destinationen mit bestimmten Attributen
Mit den Parameter "attr=<key>:<value>" werden nur Destinationen zurückgegeben, die über das entsprechende Attribut verfügen. Wird der Parameter mehrfach angegeben, so müssen Destination über alle angegebenen Attribute verfügen.
Es können mehrere Werte für ein Attribut angegeben werden, getrennt durch Leerzeichen. Eine Destination muss nur einen der angegebenen Werte enthalten. Der Parameter "attr=key1:value1 value2" würde sowohl "key1:value1" als auch "key1:value2" bei einer Destination treffen.
Abfragen von POIs für eine Destination
Es kommt eine Liste mit Informationen über POis zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten POis verfügt.
Abfragen von redaktionell zugeordnetnen POIs für eine Destination
Es kommt eine Liste mit Informationen über POis zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten POis oder sichtbaren TravelInfos verfügt.
Abfragen von redaktionell ausgezeichneten POIs für eine Destination
| User Story |
Ein User fragt zu einer Destination die POIs ab, die redaktionell über eine Buch-Serie ausgezeichnet sind. Es werden nur von sichtbaren Buchserien die POI-Zuordnungen betrachtet. POIs, die in einer Unterdestination ausgezeichnet sind, werden nicht zurückgeliefert. Mögliche Werte der Auszeichnung sind : TOP_HIGHLIGHT, HIGHTLIGHT, TOP_INSIDER_TIP, INSIDER_TIP, CONTAINED_IN, INTERESTING_FOR, LUXURY, GOURMET. |
| HTTP |
GET |
| URL |
http://api.mairdumont.com/data/destination/api/destination/4/?filter=poi&commendation=highlight,insider_tip |
Es kommt eine Liste mit Informationen über POIs zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten POIs oder sichtbaren TravelInfos verfügt.
Es kommt eine Liste mit Auszeichnungen der POIs zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten POIs oder sichtbaren TravelInfos verfügt.
Abfragen der redaktionell zugeordneten POIs eines Reiseführer-Bandes für eine Destination
Es kommt eine Liste mit Informationen über POIs zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten POIs oder sichtbaren TravelInfos verfügt.
Die BuchID sollte über eine zusätzliche Anfrage http://api.123poi.com/data/destination/api/destination/4/?filter=travelinfo&lang=de ermittelt werden, da diese sich bei einer neuen Auflage des Reiseführers ändert.
Man kann eine Liste von bookIds angeben und in mehreren Reisführer gleichzeitig zu suchen. Mit dem Value none werden alle POIs getroffen, sie nicht in einem Reiseführer vorkommen.
http://api.mairdumont.com/data/destination/api/destination/4/?filter=poi&buch=7,none
| User Story |
Ein User fragt zu einer Destination die POIs ab, die redaktionell in einen Reiseführer speziell ausgezeichnet sind. Auszeichnungen in anderen Reiseführer der selben Reihe werden nicht berücksichtigt. POIs, die in einer Unterdestination ausgezeichnet sind, werden auch mit zurückgeliefert. Mögliche Werte der Auszeichnung sind : TOP_HIGHLIGHT, HIGHTLIGHT, TOP_INSIDER_TIP, INSIDER_TIP, CONTAINED_IN, INTERESTING_FOR, LUXURY, GOURMET. |
| HTTP |
GET |
| URL |
http://api.mairdumont.com/data/destination/api/destination/4/?filter=travelpoi&buch=$buchId$&commendation=highlight,insider_tip |
Abfragen von Destinationen in denen der angegebene Geocode enthalten ist
| User Story |
Ein User fragt zu einem Geocode alle Destinationen ab, die diesen Geocode beinhalten. |
| HTTP |
GET |
| URL |
http://api.mairdumont.com/data/destination/api/destination/all/:(name,type,coordinates,bbox)?geocode=48.2,11.6
|
| Example |
{
"entries": [{
"destinationId": 23931,
"destinationName": "München",
"destinationType": "ADMIN_CITY",
"boundingBox": {
"northwest": {
"lat": 48.248123,
"lon": 11.3605883
},
"southeast": {
"lat": 48.0616006,
"lon": 11.7229192
}
},
"coordinates": {
"lat": 48.1372719,
"lon": 11.5754815
},
"creationDate": 1355826691588,
"creationDateFormatted": "2012-12-18 11:31:31 +0100",
"lastUpdate": 1372070807348,
"lastUpdateFormatted": "2013-06-24 12:46:47 +0200"
}, {
"destinationId": 6506,
"destinationName": "Bayern",
"destinationType": "ADMIN_REGION",
"boundingBox": {
"northwest": {
"lat": 50.5647336,
"lon": 8.976069
},
"southeast": {
"lat": 47.2700987,
"lon": 13.8397906
}
},
"coordinates": {
"lat": 48.9468034,
"lon": 11.4189768
},
"creationDate": 1353910921493,
"creationDateFormatted": "2012-11-26 07:22:01 +0100",
"lastUpdate": 1372059868176,
"lastUpdateFormatted": "2013-06-24 09:44:28 +0200"
}, {
"destinationId": 5618,
"destinationName": "Germany",
"destinationType": "ADMIN_COUNTRY",
"boundingBox": {
"northwest": {
"lat": 54.91740036010739,
"lon": 5.8694429397583
},
"southeast": {
"lat": 47.28110122680661,
"lon": 15.038049697876
}
},
"coordinates": {
"lat": 51.10046848648669,
"lon": 10.395422469532143
},
"creationDate": 1355825924651,
"creationDateFormatted": "2012-12-18 11:18:44 +0100",
"lastUpdate": 1361456195802,
"lastUpdateFormatted": "2013-02-21 15:16:35 +0100"
}],
"totalResults": 3,
"startIndex": 0,
"itemsPerPage": 10,
"searchTime": 0
}
|
Es kommt eine Liste mit Informationen über Destinationen zurück. Die Liste ist leer, wenn keine Destination diesen Geocode beinhaltet.
Abfragen von Destinationen (Breadcrumb) in denen der angegebene Geocode enthalten ist
| User Story |
Ein User fragt zu einem Geocode alle Destinationen in Form von Breadcrumbs ab, die diesen Geocode beinhalten. |
| HTTP |
GET |
| URL |
http://api.mairdumont.com/data/destination/api/destination/all?filter=breadcrumb&geocode=39.614152,2.987852
|
| Example |
{
"entries": [{
"destinationIdentifier": [{
"destinationId": 500,
"destinationName": "World",
"destinationType": "ADMIN_WORLD"
}, {
"destinationId": 502,
"destinationName": "Europe",
"destinationType": "ADMIN_CONTINENT"
}, {
"destinationId": 5719,
"destinationName": "Spanien",
"destinationType": "ADMIN_COUNTRY"
}, {
"destinationId": 7638,
"destinationName": "Illes Balears",
"destinationType": "ADMIN_REGION"
}, {
"destinationId": 78627,
"destinationName": "Lloret de Vistalegre",
"destinationType": "ADMIN_CITY"
}]
}, {
"destinationIdentifier": [{
"destinationId": 500,
"destinationName": "World",
"destinationType": "ADMIN_WORLD"
}, {
"destinationId": 502,
"destinationName": "Europe",
"destinationType": "ADMIN_CONTINENT"
}, {
"destinationId": 5719,
"destinationName": "Spanien",
"destinationType": "ADMIN_COUNTRY"
}, {
"destinationId": 7638,
"destinationName": "Illes Balears",
"destinationType": "ADMIN_REGION"
}, {
"destinationId": 177097,
"destinationName": "Mallorca",
"destinationType": "TRAVEL_REGION"
}, {
"destinationId": 177101,
"destinationName": "Die Inselmitte",
"destinationType": "TRAVEL_REGION"
}]
}],
"searchTime": 0
}
|
Es kommt eine Liste von Destinationen-\\\_Breadcrumbs\\\_ zurück. Die Liste ist leer, wenn keine Destinationen diesen Geocode beinhaltet.
| User Story |
Ein User fragt zu einem Geocode alle Destinationen mit Reiseinformation ab, die diesen Geocode beinhalten. Die Destinationen sind nach Relevanz sortiert. |
| HTTP |
GET |
| URL |
http://api.mairdumont.com/data/poi/api/destination/all?filter=traveldestination&lang=de&itemsperpage=1&geocode=39.567308,2.647859&country=ESP
|
| Example |
{
"entries": [{
"destinationId": 79042,
"destinationName": "Palma de Mallorca",
"destinationType": "ADMIN_CITY", #
"coordinates": {
"lat": 39.5695824,
"lon": 2.6500714
},
"creationDate": 1355835039700,
"creationDateFormatted": "2012-12-18 13:50:39 +0100",
"lastUpdate": 1447324544704,
"lastUpdateFormatted": "2015-11-12 11:35:44 +0100",
"breadcrumb": "Palma de Mallorca, Balearische Inseln, Spanien"
}],
"totalResults": 5,
"startIndex": 0,
"itemsPerPage": 1,
"searchTime": 304
}
|
Die Ergebnisliste ist leer, wenn keine Destination mit Reiseinformation den Geocode beinhaltet. Der Parameter "country" ist optional und ist bei überlappenden Städte-Polygonen im Grenzbereich von nutzen. Als Wert kann sowohl der zweistellige als auch dreistellige ISO 3166 Ländercode verwendet werden.
Abfragen von einer Destinationen Verknüpfung mit Folder
Es kommt eine Liste mit Informationen über Folder zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten Folder verfügt.
Über die Parameter "startindex" und "itemsperpage" kann wie gewohnt über die Folder geblättert werden.
Über den Parameter "user" kann auf die Folder eines Users eingeschränkt werden, z.B. "user=36".
Über den Parameter "foldertype" kann auf einen oder mehrere Folder-Typen eingeschränkt werden. Getrennt wird mit einem Komma. Mögliche Werte sind "list", "bookmark" und "search".
Über den Parameter "attr" kann auf die Folder mit bestimmten Attributen eingeschränkt werden, z.B. "&attr=Type:MP7GEN". Der Parameter kann mehrfach angegeben werden. Ein Folder muss über alle Attribute verfügen, um angezeigt zu werden. Der Wert wird über ein Like geprüft. Die Steuerzeichen ("%", "_") und Escape-Zeichen ("\") müssen entsprechend angegeben oder escaped werden.
Abfragen von Events für eine Destination
Es kommt eine Liste mit Informationen über Events zurück. Die Liste ist leer, wenn die abgefragte Destination über keine referenzierten Events verfügt.
Alphabetische Sortierung von Destinationen
TravelInfos
Es kommen alle sichtbaren Reiseinformationen der Origin OUT zurück.
Es kommen alle sichtbaren Reiseinformationen der Origin PRINT und WEB zurück.
Abfragen einer Reiseinformation nach Text Type und Sub Type (Portal)
Es kommen alle sichtbaren Reiseinformationen der Origin OUT nach Text Type und optionale Sub Texttype zurück.
Abfragen einer Reiseinformation nach Text Type und Sub Type (Redaktionssystem)
Es kommen alle sichtbaren Reiseinformationen der Origin PRINT und WEB nach Text Type und optionale Sub Texttype zurück.
Es kommt eine Liste mit Reiseinformationen zurück. Die Liste kann leer sein, wenn keine sichtbaren Reiseinformationen gefunden wurden.
Abfragen, Ändern und Löschen von Klimainformationen
HTTP-GET: Es kommt die Klimatabelle zurück, falls diese vorhanden ist.
HTTP-PUT: Die Klimatabelle wird angelegt oder, falls bereits vorhanden, überschrieben.
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:destination="http://api.123poi.com/destination/" >
<content type="application/atom+xml">
<destination:weather>
<destination:headline>Wetter in Berlin</destination:headline>
<destination:weatherTables>
<destination:weatherTable>
<destination:name>Tagestemperaturen in C°</destination:name>
<destination:unit>C°</destination:unit>
<destination:type>day</destination:type>
<destination:values>
<destination:value>2</destination:value>
<destination:value>3</destination:value>
<destination:value>8</destination:value>
<destination:value>13</destination:value>
<destination:value>19</destination:value>
<destination:value>22</destination:value>
<destination:value>24</destination:value>
<destination:value>23</destination:value>
<destination:value>19</destination:value>
<destination:value>13</destination:value>
<destination:value>7</destination:value>
<destination:value>3</destination:value>
</destination:values>
</destination:weatherTable>
</destination:weatherTables>
</destination:weather>
</content>
</entry>
Abfragen eines TravelInfo Texts
Es kommt ein TravelInfo-Text inklusive alle Artikel zurück.
Mögliche Typen von TravelInfo-Texten (destination:textType):
- CHAPTER Ein Kapitel des Bandes, z.B. "Auftakt".
- CATEGORY Eine Kategorie des Bandes, z.B. "Einkaufen".
- SPECIAL_BOX Eine SpecialBox des Bandes, z.B. "Spezialitäten".
- PSEUDO_POI Auflistung mit (meist kurzen) Beschreibungstexten von POIs, die nicht als POI in der Datenbank vorhanden sind und somit nicht über Relationen abgebildet werden können, z.B. "Top-Highlights" für ältere Bände.
- METADATA Generelle Informationen zum Band, z.B. Preisinformationen (Was kostet wieviel?).
Abfragen eines TravelInfo Artikels
Es kommt ein einzelner Artikel zurück.
Abfragen von Reiseinformationen mit eingebetteten Texten und Artikeln
Statt die Texte und Artikel einzeln abzufragen, ist es mit Granulierung auch möglich, diese direkt mit den Reiseinformationen abzufragen. Da dabei evtl. große Datenmengen verarbeitet werden, z.B. bei Länder-Destinationen, sollten diese Anfragen ggf. mit anderen Einschränkungen, z.B. Texttyp oder Buch, kombiniert werden.
Suche von TravelInfo Texts anhand von Tags
Die Tag-Liste kann Komma separiert mehrere Tags beinhalten. Diese Tags werden dann für die Suche oder verknüpft, d.h. es werden Texte zurückgeliefert die mindestens einen der gesuchten Tags besitzt. Fügt man am Anfang der Tag-Liste ein + ein, werden die Tags bei der Suche und verknüpft, d.h. es werden nur Texte zurückgeliefert die alle angegebenen Tags besitzen.
Datenstruktur eines TravelInfo Objektes
Grundlegende Struktur einer TravelInfo
{
"id": 20548,
"destinationId": 77657,
"isBookInfo": true,
"name": "Barcelona",
"book": { /* Info zum Reiseführer */ },
"travelInfoTexts": [ { /* TravelInfoText */ } ],
"weather": { /* {KlimaInfo} */ },
"creationDate": 1385641028703,
"creationDateFormatted": "2013-11-28 13:17:08 +0100",
"lastUpdate": 1412240772318,
"lastUpdateFormatted": "2014-10-02 11:06:12 +0200"
}
Struktur eines \\\*\\\*TravelInfoText\\\*\\\*:
{
"id": 116831,
"textType": "CHAPTER",
"title": "Praktische Hinweise",
"subtitle": "Von Anreise bis Zoll",
"edition": "2014-16",
"subtype": "traveltips",
"teaser": "Urlaub von Anfang bis Ende: die wichtigsten Adressen und Informationen für Ihre Barcelona-Reise",
"travelInfoArticles": [
{
"id": 221288,
"docID": 116831,
"headline": "Anreise",
"text": "..."
"articleSubType": "gettingThere",
"creationDate": 1385641020450,
"creationDateFormatted": "2013-11-28 13:17:00 +0100",
"lastUpdate": 1444296898537,
"lastUpdateFormatted": "2015-10-08 11:34:58 +0200"
},
{ /* travelInfoArticle */ }
],
"author": {"id": 13, "name": "Marco Polo", "profileImage": "http://pic.123poi.com/api/content/logos/13/icon/icon.gif"},
"creationDate": 1385641020448,
"creationDateFormatted": "2013-11-28 13:17:00 +0100",
"lastUpdate": 1443775435478,
"lastUpdateFormatted": "2015-10-02 10:43:55 +0200"
}
Buchspezifische Beschreibungstexte für POIs
Contributions sind auf einen Beschreibungstext beschränkt. Damit ein POI je nach angefragtem Band einen anderen Beschreibungstext haben kann, wurden buchspezifische Beschreibungstexte eingeführt.
Beim Anlegen eines POIs können diese buchspezifischen Beschreibungstexte mit angegeben werden. Das Buch wird dabei über seine ExternalId refrenziert, welche im XML3 des Bandes zu finden ist, zusammen mit dem Bandtyp (Region oder Stadt), welcher ebenfalls angegeben wird. Zudem wird die Quelle des Beschreibungstextes hinterlegt. Damit kann ein neben dem Print-Text auch ein spezieller Text für Web oder App hinterlegt werden.
Die Beschreibungstexte für verschiedene Bücher können nach und nach durch Updates auf die Contribution des POIs hinzugefügt, aktualisiert oder gelöscht werden. Es ist nicht notwendig, bei jedem Mal alle Beschreibungstexte für alle Bücher mitzugeben. Bestehende Beschreibungstexte werden anhand von ExternalId des Buches und der Quelle identifiziert. Um einen Beschreibungstext zu löschen, muss ein Update mit einem leeren Beschreibungstext erfolgen.
Aus den verschiedenen Beschreibungstexten wird der Beste ausgewählt. Die Quellen Web und App haben Vorrang vor Print. Der Bandtyp Stadt hat Vorrang vor Region. Als letztes entscheidet die Länge der Texte. Der beste Beschreibungstext wird als Beschreibung der Contribution gesetzt, und somit ausgeliefert. Ein evtl. vorhandener Beschreibungstext der Contribution wird dabei überschrieben.
Soll der POI im Kontext eines bestimmten Buches abgefragt werden, so kann über den book-Parameter bestimmt werden, dass der beste Beschreibungstext des angegeben Buches als Beschreibungstext zurückgegeben werden soll.
Die buchspezifischen Beschreibungstexte sind nicht Teil der Default-Granulierung. Sie können aber über die Granulierung :(poidata:(traveldescription)) abgefragt werden.
Anlegen eines POIs mit buchspezifischen Beschreibungstexten
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:poi="http://api.123poi.com/poi/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:openSearch="http://a9.com/-/spec/opensearch/1.1/">
<content type="application/atom+xml">
<poi:poi 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/">
<poi:poidata>
<poi:title>Gottlieb Daimler Stadion</poi:title>
<data:language>de</data:language>
<user:author><user:id>6</user:id></user:author>
<falkgeo:coordinates>
<falkgeo:lat>48.791599</falkgeo:lat>
<falkgeo:lon>9.229890</falkgeo:lon>
</falkgeo:coordinates>
<data:address>
<data:isoCountryCode>DE</data:isoCountryCode>
<data:location>Stuttgart</data:location>
<data:zip>70173</data:zip>
</data:address>
<data:travelDescriptions>
<data:travelDescription>
<data:bookExternalId>MP_Ligurien_Aufl2008/11_DE_region</data:bookExternalId>
<data:bookLevelOfDetail>REGION</data:bookLevelOfDetail>
<data:origin>PRINT</data:origin>
<data:description>POI-Beschreibung für Ligurien-Band (Print).</data:description>
</data:travelDescription>
<data:travelDescription>
<data:bookExternalId>MP_Ligurien_Aufl2008/11_DE_region</data:bookExternalId>
<data:bookLevelOfDetail>REGION</data:bookLevelOfDetail>
<data:origin>WEB</data:origin>
<data:description>POI-Beschreibung für Ligurien-Band (Web).</data:description>
</data:travelDescription>
<data:travelDescription>
<data:bookExternalId>MP_Rom_Aufl2008/15_DE_city</data:bookExternalId>
<data:bookLevelOfDetail>CITY</data:bookLevelOfDetail>
<data:origin>APP</data:origin>
<data:description>POI-Beschreibung für Rom-Band (App).</data:description>
</data:travelDescription>
</data:travelDescriptions>
</poi:poidata>
<data:category>
<data:id>20</data:id>
</data:category>
</poi:poi>
</content>
</entry>
Destination Quick Facts
Destinationen können über Quick Facts verfügen. Das sind Informationen über die besten Reisezeit, die Reisekategorien, die Netzstecker und ob ein Visa für einen Besuch erforderlich sind. Diese Informationen beziehen sich im Zweifelsfall immer auf die deutsche Sicht, z.B. das Feld "powerAdapterRequired" bezieht sich immer auf Geräte, die für den deutschen Markt hergestellt wurden (Adapter C/F).
Einige Informationen werden von übergeordneten Destinationen (z.B. Deutschland) an die darunterliegenden Destinationen vererbt (siehe Spalte "Vererbung", z.B. "powerPlugTypes"). Diese Informationen werden somit zentral an einer Destination gepflegt, sind aber auch an alle darunterliegenden Destinationen sichtbar.
| bestTravelMonths |
Eine Liste der besten Reisemonate, mit ID und lokalisiertem Namen. 0 steht für Januar, 1 für Februar, 11 für Dezember. |
nein |
[ { "id": 2, "name": "März" }, { "id": 9, "name": "Oktober" } ] |
| powerPlugTypes |
Aufzählung der Steckertypen, z.B. für die Darstellung der Steckertypen. |
ja |
[ "C", "F" ] |
| powerPlugDescription |
Die Aufzählung der Steckertypen für die Anzeige als Text. |
ja |
"C, F" |
| powerPlugVoltage |
Die Stromspannung in Volt, kann ggf. Kommas oder Bindestriche enthalten. |
ja |
"230" |
| powerPlugFrequency |
Die Frequenz in Hertz, kann ggf. Kommas oder Bindestriche enthalten. |
ja |
"50" |
| powerPlugAdapterRequired |
Ob ein Reiseadapter benötigt wird, um deutsche Geräte anzuschließen. Mögliche Werte sind "YES", "NO" und "PARTIAL", sowie zum Zurücksetzen der Wert "NULL". |
ja |
"NO" |
| visaRequired |
Ob als deutscher Reisender ein Reisepass und Visum benötigt wird. Mögliche Werte sind "TRUE" und "FALSE", sowie zum Zurücksetzen der Wert "NULL". |
ja |
"FALSE" |
| visaURL |
Eine URL mit weiterführenden Informationen zur Visapflicht, z.B. vom Auswärtigen Amt. |
ja |
"">http://www.auswaertiges-amt.de/DE/Laenderinformationen/00-SiHi/Nodes/AegyptenSicherheit_node.html" |
| travelCategories |
Eine Liste der Reisekategorien, für welche sich die Destination besonders eignet. |
nein |
[ { "id": 4, "name": "Meer" }, { "id": 2, "name": "Shopping" } ] |
Liste der unterstützten Reisekategorien abfragen
| 1 |
Kultur |
| 2 |
Shopping |
| 3 |
Outdoor |
| 4 |
Meer |
| 5 |
See |
| 6 |
Wintersport |
| 7 |
Feiern |
Destination Quick Facts abfragen
Die Destination Quick Facts werden mit den sonstigen Destinationsinformationen standardmäßig ausgegeben, sowohl bei Einzelanfragen als auch bei Listen. Die Felder können über die Granulierung einzeln ausgewählt werden.
Beispielausgabe
{
"entries": [ {
"destinationId": 37067,
"destinationName": "Hamburg",
"destinationType": "ADMIN_CITY",
"parentId": 5618,
"bestTravelMonths": [{
"id": 2,
"name": "März"
},
{
"id": 9,
"name": "Oktober"
}
],
"powerPlugTypes": [
"C",
"F"
],
"powerPlugDescription": "C, F",
"powerPlugVoltage": "230",
"powerPlugFrequency": "50",
"powerPlugAdapterRequired": "NO",
"visaRequired": "FALSE",
"visaURL": "http://www.auswaertiges-amt.de/DE/Laenderinformationen/00-SiHi/Nodes/AegyptenSicherheit_node.html" ,
"travelCategories": [{
"id": 4,
"name": "Meer"
},
{
"id": 2,
"name": "Shopping"
}]
}]
}
Destinationssuche auf Quick Facts einschränken
Bei der Suche nach Destinationen können Suchparameter mitgegeben werden, um nur Destinationen mit den gewünschten Eigenschaften angezeigt zu bekommen. Die möglichen Suchparameter sind "months", "visa" und "travelcat". Die Suchparameter können untereinander und mit anderen Suchparametern kombiniert werden. Bei den Parametern "months" und "travelcat" können mehrere Werte durch Kommas getrennt werden. Bei dem Parameter "travelcat" kann durch ein vorangestelles Plus-Zeichen die Suche so angepasst werden, dass die Destinationen alle angegebenen Reisekategorien treffen müssen, statt nur einer.
| months |
Zahlen zwischen 0 (Januar) und 11 (Dezember), mehrere Monate können durch Kommas getrennt angegeben werden, z.B. "4,5,6". |
Es werden nur Destinationen angezeigt, die mindestens einen der angegebenen Monate als beste Reisezeit angegeben haben. |
| visa |
"true" oder "false" |
Es werden nur Destinationen angezeigt, für die ein Visa erforderlich ist (true) oder nicht erforderlich ist (false). Die Visa-Information wird prinzipiell an untere Destination vererbt, jedoch werden vererbte Eigenschaften für die Suche ignoriert. Es werden nur Destinationen angezeigt, bei denen die Eigenschaft direkt gesetzt wurde. |
| travelcat |
IDs aus der Liste der bekannten Reisekategorien. Mehrere Reisekategorien können durch Kommas getrennt angegeben werden, z.B. "4,7". Soll eine Destination über alle angegebenen Reisekategorien verfügen, so kann ein Plus-Zeichen vorangestellt werden, z.B. "+4,7". |
Es werden nur Destinationen angezeigt, bei denen mindestens eine bzw. alle (vorangestelltes Plus-Zeichen) Reisekategorien angegeben wurden. |
Reisedauer für Destinationen
Destinationssuche auf Reisedauer (und Reiseart) einschränken
Bei der Suche nach Destinationen können Suchparameter mitgegeben werden, um nur Destinationen innerhalb der gewünschten Reisedauer angezeigt zu bekommen. Die möglichen Suchparameter sind "minDuration", "maxDuration" und "meansOfTravel". Der Suchparameter "meansOfTravel" hat allein keine Wirkung. Wird nur einer der beiden Parameter "minDuration" und "maxDuration" angegeben, so wird 0 bzw. unendlich angenommen.
| minDuration |
Die minimale Reisedauer in Minuten, z.B. "60". |
Es werden nur Destinationen angezeigt, bei denen die hinterlegte Reisedauer mit der oder den gewünschten Reisearten über der angegebenen Zeit liegt. Wird keine Reiseart (Parameter "meansOfTravel") angegeben, so werden alle Reisearten berücksichtigt. |
| maxDuration |
Die maximale Reisedauer in Minuten, z.B. "200". |
Es werden nur Destinationen angezeigt, bei denen die hinterlegte Reisedauer mit der oder den gewünschten Reisearten unter der angegebenen Zeit liegt. Wird keine Reiseart (Parameter "meansOfTravel") angegeben, so werden alle Reisearten berücksichtigt. |
| meansOfTravel |
Die geplante Reiseart. Mögliche Werte sind CAR, TRAIN und AIRCRAFT, bzw. 0, 1, 2. Es können mehrere Reisearten durch Komma kombiniert werden, z.B. "CAR,TRAIN". |
Es werden nur Destinationen angezeigt, die mit den angegebenen Reisearten in der angegebenen Reisedauer erreicht werden können. Kann eine Destination nur mit Flugzeug erreicht werden, so würde sie mit "meansOfTravel=TRAIN" nicht ausgeliefert. Kann eine Destination mit Flugzeug in 2 Stunden und mit der Bahn in 3 Stunden erreicht werden, so würde die Anfrage "meansOfTravel=TRAIN&maxDuration=120" die Destination nicht treffen. Die Anfrage "meansOfTravel=AIRCRAFT,maxDuration=120" hingegen schon. |
Sprachführer für Destinationen abfragen
Wird eine Destination abgefragt oder gesucht werden verknüpfte Sprachführer mit ausgegeben.
Beispielausgabe
"languageGuides":\[
{
"id":10,
"language":"fr",
"bookSeriesIdentifier":"MPLG",
"creationDate":1422486000000,
"creationDateFormatted":"2015-01-29 00:00:00 +0100",
"lastUpdate":1422486000000,
"lastUpdateFormatted":"2015-01-29 00:00:00 +0100"
}
\]
Beispielausgabe
{\
"entries":\[\
{\
"id":24,\
"documents":\[\
{\
"id":79,\
"title":"Sprachführer Französisch",\
"subtitle":"",\
"teaser":"Dami....",\
"articles":\[\
{\
"id":64,\
"headline":"Basics",\
"text":"Text ...",\
"teaser":"",\
"creationDate":1423053000208,\
"creationDateFormatted":"2015-02-04 13:30:00 +0100",\
"lastUpdate":1423053000208,\
"lastUpdateFormatted":"2015-02-04 13:30:00 +0100"\
},\
{\
"id":65,\
"headline":"Anreise",\
"text":"Text ...",\
"teaser":"",\
"creationDate":1423053000210,\
"creationDateFormatted":"2015-02-04 13:30:00 +0100",\
"lastUpdate":1423053000210,\
"lastUpdateFormatted":"2015-02-04 13:30:00 +0100"\
}\
\],\
"author":{\
"id":13,\
"name":"Marco Polo",\
"profileImage":"<http://testpic.123poi.com/api/content/logos/13/icon/icon.gif>"\
},\
"metaInformation":{\
"title":"Französisch",\
"keywords":"",\
"description":""\
},\
"creationDate":1423053000204,\
"creationDateFormatted":"2015-02-04 13:30:00 +0100",\
"lastUpdate":1423053000204,\
"lastUpdateFormatted":"2015-02-04 13:30:00 +0100"\
}\
\],\
"language":"fr",\
"bookSeriesIdentifier":"MPLG",\
"destinations":\[\
{\
"destinationId":5611,\
"destinationName":"France",\
"destinationType":"ADMIN_COUNTRY"\
}\
\],\
"creationDate":1423053000144,\
"creationDateFormatted":"2015-02-04 13:30:00 +0100",\
"lastUpdate":1423053000144,\
"lastUpdateFormatted":"2015-02-04 13:30:00 +0100"\
}\
\],\
"searchTime":111\
}