Manual i-Reserve - API - Event

Home Functional information Available API's API-Event

Documentation

Difficulty level:

GET event/filter

Used for

Get a list of published events. With the de search and columns attributes you can adjust the results to your needs.
For more information about filtering, visit this page about: filters
The results are shown in full format and RAW values. The original value has the suffix "_raw".

Authenticatie

Not required.

Parameters

Parameter	Description	Required	Dedfault	Example
lang	Language	No	dutch	english
search	Search string with criteria If non given the limit has a default of 100 results	No		PRODUCT IN (1,14)
columns	Columns to show	No		EVENT_ID,EVENT_DESC
start	The first row to show	No	0
length	the number of rows	No	25

Expansion

Parameter	Description
participants	The participants

Response codes

200 OK

Voorbeeld

Request a full activity (event) list with optional search filter and column specification.

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"
  }
]

Get list with participant expansion.

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"
        }
      }
    }
  }
]

By default, 25 results are returned. This can be increased via the "length" parameter, but to a maximum of 250.
By also using the start parameter, you can "browse" through the results. After all, start=250 + length=250 gives the following set of results.

If the situation arises where these values are too small, please contact support for an adjustment of the maximum value.