Die REST API ermöglicht alle öffentlichen Daten zu Performances und deren Event einer Sammlung abzufragen. Die Antwort kann dabei in XML oder JSON erfolgen. Sowohl die XML als auch die JSON Schemas sind versioniert.
Für die XML-Struktur liegt noch kein XML-Schema vor.
Für die JSON-Struktur liegt noch kein JSON-Schema vor.
Die REST Schnittstelle wird über ein HTTP GET- oder POST-Request angesteuert mit dem URL-Pfad der Sammlung. Dabei wird mit wenigen GET- oder POST-Parametern die Abfrage spezifiziert. Abgesehen von wenigen statischen Pflicht-Parameter können die folgenden optionalen Filter-Parameter verwendet werden:
category : es kann nach Kategorien gefiltert werden. Die Kategorien sind Integers und werden auch als solche in den Daten ausgegeben
1=Film
2=Theater
3=Tanz
4=Literatur
5=(Klassik, Jazz)
6=Sounds & Floors
7=Kunst
8=Kinder & Familien
9=Diverses
10=Art/Messen
11=Agenda
12=Musik, Konzerte
100=Messen & Kongr.
101=Sport
102=Gay & Lesbian
language : ISO language-code (e.g. de=Deutsch, fr=Französisch, en=Englisch)
searchTerm : freitext suchfeld
startDate : nur die Performances mit einem Start-Datum grösser oder gleich startDate werden exportiert. Das Datum muss im Format dd-mm-yyyy übermittelt werden
endDate : nur die Performances mit einem Start-Datum kleiner als endDate werden exportiert. Das Datum muss im Format dd-mm-yyyy übermittelt werden
maxHeight : Maximale Bildgrösse in Pixel. Das Bild wird unter Einhaltung der Aspect-Ratio passend verkleinert.
maxWidth : Maximale Bildgrösse in Pixel. Das Bild wird unter Einhaltung der Aspect-Ratio passend verkleinert.
Die statischen Pflicht-Parameter sind:
xpage : celements_ajax
ajax_mode : export/JSON/v1 oder export/XML/v1 ; definiert gleichzeitig das Format der Antwort, wie auch die erwünschte Schema-Version
authentication Parameters:
username : Benutzer für die Authentifizierung
token : erlaubt eine authentifizierung mit passendem Benutzer für einzelne REST-Requests.