Handbuch i-Reserve - API - Booking

Home Funktionale Informationen Verfügbare APIs API-Booking

Documentatie

difficulty level:

POST booking/check

Verwendet für

Durchführen von Prüfungen mit dem Ziel festzustellen, ob eine Reservierung erstellt werden kann.
Dieselben Prüfungen werden beim Speichern einer Reservierung durchgeführt.
Der Unterschied hier ist, dass die Reservierung nicht erstellt wird, sondern nur das Ergebnis der Prüfungen zurückgegeben wird.

Authentifizierung

Anonymer Zugriff

Parameter

Parameter	Beschreibung	Erforderlich	Beispiel
object_id	Objekt-ID der Reservierung	Ja*	1
combi_id	Objekt-ID der Reservierung	Ja*	2
fromdate	Von-Datum der Reservierung	Ja	2012-08-26
tilldate	Bis-Datum der Reservierung	Ja	2012-08-26
fromtime	Von-Zeit der Reservierung	Nein	10:00
tilltime	Bis-Zeit der Reservierung	Nein	12:00
customer	Kundenobjekt kann angegeben werden Wenn customer_id angegeben ist, wird die Reservierung mit diesem Kunden verknüpft	Nein
options	Ein Array von Optionen, jeweils mit einer Kombination aus option_name und der gewünschten Anzahl	Nein
participants	Ein Array von Teilnehmern, jeweils mit einer Kombination aus participant_name und der gewünschten Anzahl	Nein

* Object_id ODER combi_id ist erforderlich. Eines von beiden muss angegeben werden

Beispiel 1

Prüfen Sie, ob eine Reservierung für 4 Personen in einem bereits gebuchten Slot erstellt werden kann.

POST api/rest/booking/check

Request: 
{
  "object_id": "1",
  "fromdate": "2012-08-26",
  "tilldate": "2012-08-26",
  "fromtime": "10:15",
  "tilltime": "10:20",
  "number": "4"
}
Response: 
{
  "status": false,
  "messages": [
    "The selected period is not available"
  ]
}

Beispiel 2

Prüfen Sie, ob eine Reservierung für 4 Personen (2 Erwachsene und 2 Kinder) erstellt werden kann.
Geben Sie auch ein Kundenobjekt an und geben Sie eine Option an.

POST api/rest/booking/check

Request: 
{
  "object_id": "1",
  "fromdate": "2012-08-27",
  "tilldate": "2012-08-27",
  "fromtime": "10:15",
  "tilltime": "10:20",
  "number": "4",
  "customer": {
    "lastname": "Demo"
  },
  "participants": {
    "0": {
      "Volwassenen": "2"
    },
    "1": {
      "Kinderen": "2"
    }
  },
  "options": {
    "0": {
      "taart": "1"
    }
  }
}
Response: 
{
  "status": true,
  "messages": [
    "No issues found"
  ]
}