Handleiding i-Reserve - API - Object

Home Functionele informatie Beschikbare API's API-Object

Documentatie

Moeilijkheidsgraad:

GET object/filter

Gebruikt voor

het ophalen van de objecten die gepubliceerd zijn. Via de search en columns variabelen is het overzicht naar wens aan te passen.
Voor meer informatie over filteren, kijk hier: filters
De object kolommen komen overeen met de pagina in het configuratiepaneel: <<uwdomein>>/admin.php?mod=filter&context=object
De resultaten van de kolommen worden zowel in volledige opmaak als in originele waarde weergegeven. De originele waarde heeft als suffix "_raw".

Authenticatie

Geen authenticatie vereist, publieke informatie.

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

Voorbeeld

Ophalen volledige object lijst met een optionele zoek filter en kolommen.

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

Response: 
[{
  "OBJ_ID": "1",
  "OBJ_DESC": "Rondleidingen",
  "OBJ_MAINOBJID": 0,
  "obj_id": "1",
  "obj_mainobjid": "0",
  "id": 1,
  "OBJ_ID_raw": "1",
  "OBJ_DESC_raw": "Rondleidingen",
  "OBJ_MAINOBJID_raw": "0"
}, {
  "OBJ_ID":"13",
  "OBJ_DESC": "Speciale rondleidingen",
  "OBJ_MAINOBJID": 0,
  "obj_id": "13",
  "obj_mainobjid": "0",
  "id": 2,
  "OBJ_ID_raw": "13",
  "OBJ_DESC_raw": "Speciale rondleidingen",
  "OBJ_MAINOBJID_raw": "0"
}]