API - Event - GET event/filter
GET event/filter
Gebruikt voor
het ophalen van de activiteiten die gepubliceerd zijn. Via de search en columns variabelen is het overzicht naar wens aan te passen.
Voor meer informatie over filteren, kijk hier: filters
De resultaten van de kolommen worden zowel in volledige opmaak als in originele waarde weergegeven. De originele waarde heeft als suffix "_raw".
Authenticatie
Geen authenticatie vereist, publieke informatie.
Parameters
| Parameter | Omschrijving | Verplicht | Standaard | Voorbeeld |
|---|---|---|---|---|
| lang | Language | Nee | dutch | english |
| search | Search string met criteria Indien niet opgegeven wordt het resultaat beperkt tot de eerste 100 activiteiten |
Nee | PRODUCT IN (1,14) | |
| columns | Kolommen om weer te geven | Nee | EVENT_ID,EVENT_DESC | |
| start | De eerste rij in het zoekresultaat | Nee | 0 | |
| length | het aantal rijen | Nee | 25 |
Expansie
| Parameter | Omschrijving |
|---|---|
| participants | De deelnemers die kunnen inschrijven op het event |
Response codes
- 200 OK
Voorbeeld
Ophalen activiteit lijst met een optionele zoek filter en kolommen.
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"
}
]
Ophalen activiteit lijst met expansie op deelnemers.
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"
}
}
}
}
]
Standaard worden 25 resultaten teruggegeven. Via de "length" parameter is dit te verhogen, echter naar een maximum van 250.
Door de parameter start ook te gebruiken, kan er "gebladerd" worden door de resultaten. Immers, start=250 + length=250 geeft de volgende set aan resultaten.
Mocht de situatie zich toch voordoen dat deze waardes te krap zijn, neem contact op met support voor een aanpassing van de maximum waarde.
