Handleiding i-Reserve - API - Booking

Home Functionele informatie Beschikbare API's API-Booking

Documentatie

Moeilijkheidsgraad:

POST booking/check

Gebruikt voor

Uitvoeren controles met als doel te bepalen of een reservering gemaakt kan worden.
Dezelfde controles worden uitgevoerd bij het opslaan van een reservering.
Het verschil hier is dat de reservering niet gemaakt wordt, enkel het resultaat van de controles wordt teruggeven.

Authenticatie

Anonieme toegang

Parameters

Parameter	Omschrijving	Verplicht	Voorbeeld
object_id	Object ID van de reservering	Ja*	1
combi_id	Object ID van de reservering	Ja*	2
fromdate	Vanaf datum van de reservering	Ja	2012-08-26
tilldate	Tot datum van de reservering	Ja	2012-08-26
fromtime	Vanaf tijd van de reservering	Nee	10:00
tilltime	Tot tijd van de reservering	Nee	12:00
customer	Klant object kan worden opgegeven Als customer_id is opgegeven, dan wordt de reservering gekoppeld aan deze klant	Nee
options	Een array van opties, elk met een combinatie van option_name en het gewenste aantal	Nee
participants	Een array van deelnemers, elk met een combinatie van participant_name en het gewenste aantal	Nee

* Object_id OF combi_id is vereist. Eén van beide dient opgegeven te worden

Voorbeeld 1

Controleer of een reservering kan worden gemaakt voor 4 mensen op een slot welke al geboekt is.

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

Voorbeeld 2

Controleer of een reservering gemaakt kan worden voor 4 mensen (2 volwassenen en 2 kinderen).
Geef ook een klant object mee en geef een optie op.

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