Handbuch i-Reserve - API - Object

Home Funktionale Informationen Verfügbare APIs API-Object

Documentatie

difficulty level:

GET object/filter

Verwendet für

das Abrufen der veröffentlichten Objekte. Über die Variablen search und columns lässt sich die Übersicht nach Wunsch anpassen.
Weitere Informationen zum Filtern finden Sie hier: Filter
Die Objektspalten entsprechen der Seite im Konfigurationspanel: <<uwdomein>>/admin.php?mod=filter&context=object
Die Ergebnisse der Spalten werden sowohl in vollständiger Formatierung als auch im ursprünglichen Wert angezeigt. Der ursprüngliche Wert hat das Suffix "_raw".

Authentifizierung

Keine Authentifizierung erforderlich, öffentliche Informationen.

Parameters

Parameter	Description	Required	Default	Example
lang	Language	No	dutch	english
search	Search string with criteria	No		OBJ_ID IN (1,14)
columns	Anzuzeigende Spalten	No		OBJ_ID,OBJ_DESC

Response codes

200 OK

Beispiel

Abrufen der vollständigen Objektliste mit einem optionalen Suchfilter und Spalten.

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"
}]