API - Event - GET event/filter
GET event/filter
Verwendet für
das Abrufen der veröffentlichten Aktivitäten. Über die Variablen search und columns lässt sich die Übersicht nach Wunsch anpassen.
Weitere Informationen zum Filtern finden Sie hier: Filter
Die Ergebnisse der Spalten werden sowohl in vollständiger Formatierung als auch als Originalwert angezeigt. Der Originalwert hat den Suffix "_raw".
Authentifizierung
Keine Authentifizierung erforderlich, öffentliche Informationen.
Parameter
| Parameter | Beschreibung | Erforderlich | Standard | Beispiel |
|---|---|---|---|---|
| lang | Sprache | Nein | dutch | english |
| search | Suchstring mit Kriterien Wenn nicht angegeben, wird das Ergebnis auf die ersten 100 Aktivitäten beschränkt |
Nein | PRODUCT IN (1,14) | |
| columns | Anzuzeigende Spalten | Nein | EVENT_ID,EVENT_DESC | |
| start | Die erste Zeile im Suchergebnis | Nein | 0 | |
| length | die Anzahl der Zeilen | Nein | 25 |
Erweiterung
| Parameter | Beschreibung |
|---|---|
| participants | Die Teilnehmer, die sich für das Event anmelden können |
Antwortcodes
- 200 OK
Beispiel
Abrufen der Aktivitätsliste mit einem optionalen Suchfilter und Spalten.
GET api/rest/event/filter?search=PRODUCT IN (1,14)&columns=EVENT_ID,EVENT_DESC
Response:
[
{
"EVENT_ID": "2018-05-02_6",
"EVENT_DESC": "Event:2018-05-02_6",
"NUMBER_OF_FREE": 13,
"event_id": "2018-05-02_6",
"event_free": "13",
"id": 1,
"EVENT_DESC_raw": "Event:2018-05-02_6",
"NUMBER_OF_FREE_raw": "13"
},
{
"EVENT_ID": "2018-05-02_9",
"EVENT_DESC": "",
"NUMBER_OF_FREE": 18,
"event_id": "2018-05-02_9",
"event_free": "18",
"id": 2,
"EVENT_DESC_raw": "",
"NUMBER_OF_FREE_raw": "18"
}
]
Abrufen der Aktivitätsliste mit Erweiterung auf Teilnehmer.
GET api/rest/event/filter?expand=participants&search=PRODUCT IN (1,14)&columns=EVENT_ID,EVENT_DESC
Response:
[
{
"EVENT_ID": "2018-05-02_6",
"EVENT_DESC": "Event:2018-05-02_6",
"NUMBER_OF_FREE": 13,
"event_id": "2018-05-02_6",
"event_free": "13",
"id": 1,
"EVENT_DESC_raw": "Event:2018-05-02_6",
"NUMBER_OF_FREE_raw": "13",
"participants": {
"object": {
"1": {
"id": "1",
"price": 15,
"currency": "EUR",
"name": "18+",
"desc": "18+",
"amount": "0",
"min": "1",
"max": "100",
"calcconversion": "1",
"calctotal": "Ja"
},
"2": {
"id": "2",
"price": 12.5,
"currency": "EUR",
"name": "Jongeren van 12-18 (minimaal 1 pers. 18+)",
"desc": "12-18 jaar",
"amount": "0",
"min": "0",
"max": "100",
"calcconversion": "1",
"calctotal": "Ja"
}
}
}
},
{
"EVENT_ID": "2018-05-02_9",
"EVENT_DESC": "",
"NUMBER_OF_FREE": 18,
"event_id": "2018-05-02_9",
"event_free": "18",
"id": 2,
"EVENT_DESC_raw": "",
"NUMBER_OF_FREE_raw": "18",
"participants": {
"object": {
"1": {
"id": "1",
"price": 15,
"currency": "EUR",
"name": "18+",
"desc": "18+",
"amount": "0",
"min": "1",
"max": "100",
"calcconversion": "1",
"calctotal": "Ja"
},
"2": {
"id": "2",
"price": 12.5,
"currency": "EUR",
"name": "Jongeren van 12-18 (minimaal 1 pers. 18+)",
"desc": "12-18 jaar",
"amount": "0",
"min": "0",
"max": "100",
"calcconversion": "1",
"calctotal": "Ja"
}
}
}
}
]
Standardmäßig werden 25 Ergebnisse zurückgegeben. Über den Parameter "length" lässt sich dies erhöhen, jedoch bis zu einem Maximum von 250.
Durch die zusätzliche Verwendung des Parameters start kann durch die Ergebnisse "geblättert" werden. Denn start=250 + length=250 liefert die nächste Ergebnismenge.
Sollte dennoch die Situation eintreten, dass diese Werte zu knapp bemessen sind, wenden Sie sich an den Support, um den Maximalwert anpassen zu lassen.
