Documentatie
Moeilijkheidsgraad:
API - Hook - POST hook/booking/
Inkomende hook om een reservering te maken of bij te werken
POST hook/booking/
Gebruikt voor
Inkomende hook om een reservering te maken of bij te werken.
Authenticatie
Gebruiker dient ingelogd te zijn op beheerdersniveau.
Recht: entity_booking_update
Parameters
Deze tabel geeft een aantal van de kern variabelen weer. Een volledig overzicht staat hier.
Parameter | Omschrijving | Verplicht | Locatie | Voorbeeld |
---|---|---|---|---|
id | Het reserverings ID | Nee * | Body | 15492 |
object_id | Het object ID | Nee * | Body | 17 |
date_from | Datum vanaf in ISO | Nee * | Body | 2018-02-13T11:30:00+0100 |
date_till | Datum tot in ISO | Nee * | Body | 2018-02-13T11:30:00+0100 |
number | Aantal | Nee * | Body | |
remarks | Opmerkingen | Nee | Body | |
subchannel | Kanaal, voor rapportage doeleinden | Nee | Body | hook |
cust_id | Klant ID | Nee | Body | |
Indien opgegeven wordt klant geprobeerd te vinden obv email | Nee | Body | ||
external_id | Indien opgegeven wordt een reservering gezocht met dit externe id | Nee | Body | |
status_code | Indien opgegeven wordt een status overgang uitgevoerd met de opgegeven status code als doel status | Nee | Body | 30 |
* Geen van de variabelen is primair verplicht. Een juiste combinatie van variabelen is wel verplicht en bepaalt de uit te voeren actie.
- Indien "id" opgegeven, dan wordt de reservering bijgewerkt met de opgegeven velden.
- Indien "id" niet is opgegeven maar "external_id" wel dan wordt de reservering bijgewerkt met dat external_id
- Indien "id" en "external_id" niet zijn opgegeven òf deze zijn opgegeven maar kunnen niet gevonden worden, dan wordt een nieuwe reservering gemaakt.
- Bij het maken van een nieuwe reservering zijn de kernvelden verplicht: "object_id", "date_from", "date_till", "number"
Voorbeeld
Maken reservering.
POST api/rest/hook/booking/
Request { "object_id": 10, "date_till": "2018-02-13T11:30:00+0100", "date_from": "2018-02-13T09:30:00+0100", "remarks": "", "email": "info@teqa.nl", "external_id": "3114hqq4rqsvlhgr8s66msvju9" }
Response: { "id": "1126", "object_id": 10, "object": "Catharinadal", "object_desc": "Catharinadal", "date_from": "2018-02-13T09:30:00+0100", "date_till": "2018-02-13T11:30:00+0100", "number": 1, "remarks": "", "mainobject_desc": "Stats", "mainobject_id": 5, "fromtime": "09:30", "tilltime": "11:30", "status_code": "11", "status": "In optie", "customer_id": "460", "customer": "Dhr. T. Ester", "email": "info@teqa.nl", "event_id": null, "price": 0, "currency": "EUR", "custom06": "", "custom07": "0", "custom12_raw": null, "custom12": "" }
Reserveringsvelden worden hier weergegeven Overzicht reserveringsvelden