Kommentare

Dieses Dokument beschreibt die REST-Schnittstellen für Kommentare. Dieses Dokument ist Teil der Dokumentation der REST-API-Schnittstellen der MD Content-API.

Inhaltsverzeichnis

Operationen auf Kommentaren (CRUD)

Anlegen eines Kommentars

Anlegen eines Kommentars für POI

**
**

Anlegen eines Kommentars für Media

**
**

Anlegen eines Kommentars für Destination

Die Daten, die angelegt werden sollen müssen im entsprechenden XML-Format angegeben und im Request Body mitgegeben werden. Dafür verwendet man ein entprechendes Tool.

Die Daten werden als neuer Eintrag <entry/> gepostet, Beispiel für ein XML:

<entry xmlns='http://www.w3.org/2005/Atom' xmlns:data="http://api.123poi.com/data/" xmlns:user="http://api.123poi.com/user/">
       <title type='text'>Kommentar zum Zeitgeschichtlichen Forum Leipzig</title>
       <content type='application/atom+xml'>
         <data:comment>
           <data:subject>Neubau im Stadtzentrum</data:subject>
           <data:text>Das 1999 eröffnete Zeitgeschichtliche Forum ist eine Dependance des Hauses der Geschichte in Bonn. 
              Es befindet sich in einem Neubau im Leipziger Stadtzentrum.</data:text>
           <data:language>de</data:language>
         </data:comment>
       </content>
     </entry>
    

Eine vollständige Beschreibung des Formates findet sich in der Dokumentation des  POI API XML-Schema.

Das Ergebnis dieses Requests teilt die URL mit, unter der der neue Kommentar erreichbar ist.

Ändern eines Kommentars

oder mit dem neuen Pfad:

Für diese Operation wird ein HTTP-PUT Request verwendet, der Pfad dieser Operation verweist auf den Kommentar mit seiner ID.

Beispiel

 PUT http://api.123poi.com/data/api/6587945/comment/1
     
     <entry xmlns='http://www.w3.org/2005/Atom' xmlns:data="http://api.123poi.com/data/">
       <title type='text'>Kommentar zum Zeitgeschichtlichen Forum Leipzig</title>
       <content type='application/atom+xml'>
         <data:comment>
           <data:subject>Gebäude im Zentrum Leipzigs</data:subject>
           <data:text>Das 1999 eröffnete Zeitgeschichtliche Forum ist eine Dependance des Hauses der Geschichte in Bonn. 
               Es befindet sich in einem Neubau im Leipziger Stadtzentrum.</data:text>        
           <data:language>de</data:language>
         </data:comment>
       </content>
     </entry>
    

Das dabei verwendete Eingabedatenformat entspricht dem eines POST Requestes. Es müssen alle Daten erneut mitgesendet werden.

Löschen eines Kommentars

oder mit dem neuen Pfad:

Kommentare löschen kann nur ein privilegierter User der das Recht zum Löschen eines Kommentars besitzt. Ein normaler angemeldeter User hat dieses Recht nicht. Über folgenden Aufruf kann, falls das Recht vorhanden ist, ein Kommentar gelöscht werden:

 DELETE http://api.123poi.com/data/api/6587945/comment/1
    

Abfragen von Kommentaren

oder mit dem neuen Pfad:

Es gibt verschiedene Möglichkeiten Kommentare abzurufen. Es können alle Kommentare eines POIs, alle Kommentare eines Benutzers sowie einzelne Kommentare angefragt werden.

Kommentare eines POIs

Kommentare einer Media

Kommentare einer Destination

Kommentare eines Benutzers

Ein bestimmter Kommentar

oder mit dem neuen Pfad:

Sperrung eines Kommentars

Der Redakteur kann einen Kommentar inaktiv setzen, dann wird der Kommentar nicht mehr angezeigt, aber nicht von der Datenbank löschen.