/
Event Export (JSON / XML) - v2

Event Export (JSON / XML) - v2

Der Event Export ist eine REST API, welche Abfragen auf alle öffentliche Veranstaltungen (Event) einer Sammlung (Collection) mit deren Aufführungen (Performance) ermöglicht. Die Antwort kann dabei in JSON oder XML erfolgen. Die Schnittstelle ist versioniert (siehe ajax_mode), diese Dokumentation bezieht sich auf die Version v2. Die Dokumentation zu Version v1 ist hier zu finden.

Detail Beschrieb

Die REST Schnittstelle wird über ein HTTP GET- oder POST-Request angesteuert mit dem URL-Pfad der gwünschten Sammlung. Dabei wird mit mittels GET- oder POST-Parametern die Abfrage spezifiziert. Abgesehen von wenigen statischen Pflicht-Parameter können die folgenden optionalen Filter-Parameter verwendet werden:

  • fromDate : yyyy-MM-dd : schränkt die Events ein auf solche mit einem Startdatum, welches später oder gleich fromDate liegt. Der Standardwert ist heute.

  • toDate : yyyy-MM-dd (default fromDate + 1 Monat) : schränkt die Events ein auf solche mit einem Startdatum vor toDate. Der Standardwert ist fromDate + 1 Monat.

  • modifiedSince : yyyy-MM-dd : schränkt die Events ein auf solche mit einem letzten Änderungsdatum nach modifiedSince.

  • category : string(,string,…) : schränkt die Events nach Kategorien ein. Die Kategorien sind String-Keys und werden auch als solche in den Daten ausgegeben TODO Liste category. Erlaubt mehrfache Werte (kommagetrennt).

  • searchTerm : str(,str,…) : Suchbegriffe für Volltextsuche. Erlaubt mehrfache Werte (kommagetrennt).

  • expectedLanguages : str(,str,…) : Erwartete Sprachen der Events (Standard alle verfügbaren) in ISO 639-1 2-Bustabe-Codes. Erlaubt mehrfache Werte (kommagetrennt).

  • sortField : str(,str,…) : Felder für die alternative Sortierungen der Resultate (Standard chronologisch). Erlaubt mehrfache Werte (kommagetrennt).

  • limit : int : limitiert die Anzahl ausgegebener Events. Relevant für Paging.

  • offset : int : verschiebt die ausgegebenen Events um Anzahl. Relevant für Paging.

  • skipEmpty : true/false : gibt bei true Events ohne mind. eine Aufführungen nicht aus.

  • allPerformances : true/false : zeigt bei true für die ausgegebenen Events zusätzlich Aufführungen, welche ausserhalb der angegebenen Sammlung liegen, an.

Die statischen Pflicht-Parameter sind:

  • xpage : celements_ajax

  • ajax_mode : definiert das Format der Antwort und die erwünschte Schema-Version mittels folgenden Werten:

    • export/event/JSON/v2

    • export/event/XML/v2

  • username : Benutzer für die Authentifizierung

  • token : erlaubt eine Authentifizierung mit passendem Benutzer für einzelne REST-Requests.

Beispiel URL: http://my.prog.online/CollectionX?xpage=celements_ajax&ajax_mode=export/event/JSON/v2&searchTerm=foo&fromDate=2020-12-31&limit=100&offset=200&skipEmpty=true