Documentation
Difficulty level:
API - Booking - GET booking/filter
GET booking/filter
Used for
Retrieving reservations. Using the search and columns variables, the overview can be customized as desired.
For more information about filtering, see here: filters
The results of the columns are displayed both in formatted form and as the original value. The original value has the suffix "_raw".
Authentication
User must be logged in with administrator-level access.
Parameters
| Parameter | Description | Required | Default | Example |
|---|---|---|---|---|
| lang | Language | No | dutch | english |
| search | Search string with criteria If not provided, the result is limited to the first 100 activities |
No | PRODUCT IN (1,14) | |
| columns | Columns to display | No | RES_ID,OBJ_DESC | |
| start | The first row to be returned | No | 10 | |
| length | The number of rows to be returned | No | 100 | |
| filter_id | ID of the filter you want to use | No | 1 |
Response codes
- 200 OK
Example
Retrieve the full reservation list with an optional search filter and columns.
GET api/rest/booking/filter?search=BOOKING_ID > 1000&columns=RES_ID,RES_FROMDATE,RES_FROMTIME
Response:
[
{
"RES_ID": "8451",
"RES_FROMDATE": "23-09-2018",
"RES_FROMTIME": "02:30 pm",
"RES_CUST_ID": 6789,
"res_id": "8451",
"res_cust_id": "6789",
"id": 1,
"RES_ID_raw": "8451",
"RES_FROMDATE_raw": "2018-09-23",
"RES_FROMTIME_raw": 52200,
"RES_CUST_ID_raw": "6789"
},
{
"RES_ID": "...
