Documentation
Difficulty level:
API - Object - GET object/{id}
GET object/{id}
Used for
getting the information of a specific object.
Authentication
No authentication required, public information.
Parameters
| Parameter | Description | Required | Default | Example |
|---|---|---|---|---|
| id | ID of the object | Yes | 2 | |
| lang | Language | No | dutch | ?lang=english |
Expansion
| Parameter | Description |
|---|---|
| extras | The extras for the object |
| participants | The participants for the object |
| settings | Technical and functional settings of the object |
Response codes
- 200 OK
- 404 Not found
Example
Getting the information of object 17.
GET api/rest/object/17?lang=english&expand=extras
Response:
{
"id": 17,
"active": true,
"grp_id": 2,
"ismainobj": true,
"mainobjid": 0,
"desc": "Bungalow normal",
"short_desc": "",
"long_desc": "Bungalow normal",
"long_memo": "",
"places_single": "",
"places_plural": "",
"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": null,
"ext_group": null,
"ext_desc": null,
"ext_dspprice": null,
"ext_remark": null,
"ext_long_memo": null
}
}
}
