5 Endpunkte

Wird verwendet, um Objekte eines Typs aufzulisten. Bspw. können alle Veranstaltungen aufgelistet werden mit /api/veranstaltungen. Klassennamen sind immer im Plural, also z. B. veranstaltungen, anmeldungen, kontakte, …

Sowohl die Ergebnismenge (welche Objekte angezeigt werden) als auch die angezeigten Felder werden bestimmt durch die Abfrage, die verwendet wird. Eine Anfrage kann Filter, Gruppierungen und Aggregationen beinhalten. Abfragen sind das API-Äquivalent zu Reports in der GUI.

Über das in der Schnittstelle hinterlegte Berechtigungsset wird bestimmt, welche Abfragen zur Verfügung stehen, und damit auch, welche Objekte aufgelistet werden können. Wenn keine Abfrage explizit angegeben wird, wird versucht, die allgemeingültigste Abfrage zu verwenden. Für größtmögliche Stabilität empfehlen wir, immer eine Abfrage per Autowert anzugeben.

Eine Abfrage wird per Name oder (besser) Autowert mit dem GET-Parameter "abfrage" angegeben:

Die verwendete Abfrage wird immer in "abfrage" angegeben.

Das Antwortformat sieht wie folgt aus:

Listen werden immer in Seiten von 100 Einträgen unterteilt. Mit dem GET-Parameter seitenindex kann auf die Seiten zugegriffen werden. Die Endpunkte zur nächsten und vorherigen Seite werden auch als Navigationsobjekt zurück gegeben. Bei jedem aufgelisteten Objekt wird der Endpunkt für die Detailinformationen ebenfalls unter link als Navigationsobjekt. Verfügbare Klassenmethoden (ohne Bezug auf ein bestimmtes Objekt) sind ebenfalls als Navigationsobjekte unter methoden aufgelistet.

Listet alle verfügbaren Attribute und deren Werte eines Objektes auf, sowie den eigenen Endpunkt, die Endpunkte von Kindlisten und die Endpunkte von Methoden. Hier wird der Singular verwendet, also z. B. /api/veranstaltung/cmx682de38637859.

Listet Kindobjekte eines Objektes auf, also beispielsweise alle Anmeldungen zu einer Veranstaltung. Das Rückgabeformat ist das gleiche wie bei normalen Listen, nur ohne Methoden.

Klassenmethoden sind Methoden, die sich nicht auf ein bestimmtes Objekt beziehen, oder das Objekt der Klasse erst erstellen (bspw. Import aus einem bestimmten Format). Die zu verwendende HTTP-Methode und GET-Parameter werden über das Endpunkt-Objekt mitgeteilt, die zu übertragenden Daten und das Antwortformat ist von der konkreten Methode abhängig. Zukünftig verfügbar werdende Methoden werden nach Möglichkeit in dieser Dokumentation aufgelistet.

Diese Methoden beziehen sich auf ein bestimmtes Objekt. Ansonsten gilt dasselbe wie für Klassenmethoden.

Erstellt ein Objekt von der angegebenen Klasse. Es werden alle Standardwerte befüllt. Im Anfrage-Body können Attribute mit zu setzenden Werten angegeben werden, die direkt nach dem Erstellen gesetzt werden sollen:

{

"name": "Hanne’s und Bärbel’s Strickkurs",

}

Schlüssel = Attributname. Wenn die Werte nicht gesetzt werden können, wird das Objekt nicht erstellt. Das erstellte Objekt wird im Anschluss zurückgegeben.

Erstellt ein Objekt der Kindklasse, im Kontext des angegebenen Objektes. Bspw: POST /veranstaltung/cmx682de38637859/anmeldung erstellt eine Anmeldung im Kontext der Veranstaltung mit dem gegebenen Autowert. Das heißt, dass die Verknüpfung der Anmeldung zur Veranstaltung schon automatisch gesetzt wird.

Löscht das angegebene Objekt. Es werden auch die zugehörigen Kindobjekte mitgelöscht, etwa Termine beim Löschen einer Terminserie.

Setzt die im Body angegebenen Werte. Wenn ein Fehler auftritt, werden keine der angegebenen Werte gesetzt (also entweder wird alles oder nichts gesetzt, keine Teilmenge). Format des Anfrage-Bodys ist wie beim Erstellen von Objekten.