Documentatie
Moeilijkheidsgraad:
API - Object - GET object/{id}
GET object/{id}
Gebruikt voor
ophalen van kenmerken voor een specifiek object.
Authenticatie
Geen authenticatie vereist, publieke informatie.
Parameters
| Parameter | Description | Required | Default | Example |
|---|---|---|---|---|
| id | ID of the object | Yes | 2 | |
| lang | Language | No | dutch | ?lang=english |
| fields | voor het ophalen van de velden als gecombineerd met vorige veld vervang dan ? door & |
?fields=txt_custom01,txt_custom02 |
Expansie
| Parameter | Description |
|---|---|
| extras | De opties bij dit object |
| participants | De deelnemer types |
| settings | Technical and functional settings of the object |
| periods | De periodes |
| resources | De resources |
| subobjects | De sub objecten |
Response codes
- 200 OK
- 404 Not found
Voorbeeld
Ophalen object 17 met expansie voor de opties in het nederlands.
GET api/rest/object/17?lang=dutch&expand=extras
Response:
{
"id": 17,
"active": true,
"grp_id": 2,
"ismainobj": true,
"mainobjid": 0,
"desc": "Bungalow standaard",
"short_desc": "",
"long_desc": "Bungalow standaard",
"long_memo": "Vrijstaande bungalow, voorzien van 1 slaapkamers plus keuken. \r\n\r\nVanaf 200 euro per weekend. ",
"places_single": "bungalow",
"places_plural": "bungalows",
"extras": {
"115": {
"ext_id": "115",
"ext_obj_id": "17",
"ext_com_id": "0",
"ext_prio": "0",
"ext_type": "A",
"ext_number": "0",
"ext_pricetype": "0",
"ext_price": null,
"ext_currency": null,
"ext_priceperiod": "0",
"ext_validperiod": "0",
"ext_priceprt_id": "0",
"ext_vat_id": "0",
"ext_fee_id": "0",
"ext_account_code": null,
"ext_account_sign": null,
"ext_mandatory": "0",
"ext_adminonly": "0",
"ext_recommended": "0",
"ext_prt_id": "0",
"ext_pricecalc": "0",
"ext_name": "test",
"ext_group": null,
"ext_desc": "test",
"ext_dspprice": null,
"ext_remark": "test",
"ext_long_memo": "test"
}
}
}
