Handbuch i-Reserve - API - Event

Home Funktionale Informationen Verfügbare APIs API-Event

Documentatie

difficulty level:

GET event/search

Verwendet für

Durchsuchen aller Events und Zurückgeben der Events für die angegebenen Kriterien.

Authentifizierung

Keine Authentifizierung erforderlich, öffentliche Informationen.

Parameter

Parameter	Beschreibung	Erforderlich	Standard	Beispiel
lang	Sprache	Nein	dutch	english
DateFrom	Startdatum des zu durchsuchenden Zeitraums	Nein	Today
DateTill	Enddatum des zu durchsuchenden Zeitraums	Nein	Today + 7 days
params	Ein Array von harten und weichen Kriterien im JSON-Format Benutzerdefinierte Event-Felder, der Anzeigename kann verwendet werden, wenn dieser eindeutig ist Benutzerdefinierte Objekt-Felder, der Anzeigename kann verwendet werden, wenn dieser eindeutig ist	Nein	<empty>	params=[{"event_custom01":"Utrecht","operator":"=","type":"OR"},{"province":"Groningen","operator":"=","type":"OR"}]
page	Die anzuzeigende Seite	Nein	1
per_page	Die Anzahl der Datensätze pro Seite	Nein	10	Maximal 100 Events pro Seite

Beachten Sie, dass die params URL-codiert sein müssen. Das bedeutet, es wird wie "params=[{%22event_cust" aussehen.
Params können mehrere Kriterien enthalten. Standardmäßig ist type AND. Standardmäßig ist der operator "=". Diese können aus der Anfrage weggelassen werden, wenn die Standardwerte gelten.
Sowohl der Anzeigename als auch der technische Name können in params verwendet werden. Wenn der Anzeigename verwendet wird, muss der Anzeigename eindeutig sein, andernfalls wird ein Fehler ausgelöst.

Antwortcodes

200 OK
412 Precondition failed: Display name not unique

Beispiel

Durchsuchen der Events.

GET api/rest/event/search/?DateFrom=2012-08-01&DateTill=2012-08-11&page=1&per_page=5&lang=dutch

Response: 
{
  "page": 1,
  "pages": 24,
  "per_page": 5,
  "total": 117,
  "events": [
    {
      "event_id": "2012-08-08_1",
      "object_desc": "Hiking",
      "event_desc": "Hiking in summer",
      "DateFrom": "2012-08-08 10:00:00",
      "DateTill": "2012-08-08 12:00:00",
      "location": "forest",
      "Booked": "6",
      "Free": "4"
    },
    {
      "event_id": "2012-08-09_1",
      "object_desc": "Hiking",
      "event_desc": "Hiking in afternoon",
      "DateFrom": "2012-08-09 13:00:00",
      "DateTill": "2012-08-09 17:00:00",
      "Booked": "6",
      "Free": "4"
    }
  ]
}