Manual i-Reserve - API - Object

Home Functional information Available API's API-Object

Documentation

Difficulty level:

GET object/filter

Used for

getting the objects which are published. Via the search and columns variables the overview can be adjusted.
For more information about filters, check here.
The object columns can be looked up via the panel in the configuation site: <<yourdomain>>/admin.php?mod=filter&context=object
The results are displayed with the requested columns plus the original values. The original values are displayed via the suffix "_raw".

Authentication

No authentication required, public information.

Parameters

Parameter	Description	Required	Default	Example
lang	Language	No	dutch	english
search	Search string with criteria	No		OBJ_ID IN (1,14)
columns	Kolommen om weer te geven	No		OBJ_ID,OBJ_DESC

Response codes

200 OK

Example

Get list of objects for ids 1 and 14. .

GET api/rest/object/filter?search=OBJ_ID IN (1,14)&columns=OBJ_ID,OBJ_DESC

Response: 
[{
  "OBJ_ID": "1",
  "OBJ_DESC": "Tours",
  "OBJ_MAINOBJID": 0,
  "obj_id": "1",
  "obj_mainobjid": "0",
  "id": 1,
  "OBJ_ID_raw": "1",
  "OBJ_DESC_raw": "Tours",
  "OBJ_MAINOBJID_raw": "0"
}, {
  "OBJ_ID": "13",
  "OBJ_DESC": "Special tours",
  "OBJ_MAINOBJID": 0,
  "obj_id": "13",
  "obj_mainobjid": "0",
  "id": 2,
  "OBJ_ID_raw": "13",
  "OBJ_DESC_raw": "Special tours",
  "OBJ_MAINOBJID_raw": "0"
}]