Handleiding i-Reserve - API - Booking

Home Functionele informatie Beschikbare API's API-Booking

Documentatie

Moeilijkheidsgraad:

POST booking/add

Gebruikt voor

Maken van een reservering. Dezelfde controles als in de check functie.
Als alle controles goed zijn wordt de reservering gemaakt.

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
number	Aantal plaatsen	Nee	1
tilldate	Tot datum van de reservering. Indien niet gezet gelijk aan fromdate	Nee	2012-08-26
fromtime	Vanaf tijd van de reservering	Nee	10:00
tilltime	Tot tijd van de reservering	Nee	12:00
customer	Klant object can opgegeven worden Als customer_id is opgegeven wordt de reservering gekoppeld aan die klant	Nee
options	Een lijst van opties, elk met een combinatie van option_name en het gewenste aantal	Nee
participants	Een lijst van deelnemers, elk met een combinatie van participant_name en het gewenste aantal	Nee
voucher	Een lijst van kadobonnen. Alleen geldige kadobonnen worden gebruikt. Er wordt geen feedback gegeven over ongeldige bonnen	Nee	VALIDVOUCHER1,VALIDVOUCHER2,INVALIDVOUCHER

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

Voorbeeld 1

Maak een reservering voor 4 personen op een reeds geboekt slot.

POST api/rest/booking/add

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

Voorbeeld 2

Maak een reservering voor 4 mensen (2 volwassenen en 2 kinderen).
Geef ook een klant object mee en geef een optie op.

POST api/rest/booking/add

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,
  "booking_id": 40690,
  "messages": [
    "Booking made"
  ]
}

Voorbeeld 3 - Overflow booking

Maken van een reservering voor 8 personen (5 volwassenen en 3 kinderen).
"Overloop van periodes" ofwel het "gebruik van meerdere periodes indien nodig" is van toepassing.

POST api/rest/booking/add

Request: 
{
  "object_id": "1",
  "fromdate": "2012-08-27",
  "tilldate": "2012-08-27",
  "fromtime": "10:15",
  "tilltime": "10:25",
  "customer": {
    "lastname": "Demo"
  },
  "participants": {
    "0": {
      "Volwassenen": "5"
    },
    "1": {
      "Kinderen": "3"
    }
  }
}
Response: 
{
  "status": true,
  "booking_id": 40693,
  "messages": [
    "Booking made"
  ]
}