[[start#objects|<< zurück]]

==== area object ====

^ Method  ^ URL                           ^ Notes                                                                ^
| GET     | /rest/{IF}/area               | returns a list of all areas                                          |
| GET     | /rest/{IF}/area/{id}  | returns information about a single area object  |
| GET     | /rest/{IF}/area/{id}/area     | returns the connected areas in the hirarchy                          |
| GET     | /rest/{IF}/area/{id}/netarea  | returns the connected netareas                                       |
| GET     | /rest/{IF}/area/{id}/address  | returns a list of all addresses of the area                          |
| GET     | /rest/{IF}/area/{id}/tenant   | returns a list of all tenants that are belongin to the area          |
| GET     | /rest/{IF}/area/{id}/device   | returns a list of all devices depending to (installed in) this area  |

== available parameters ==

^ Parameter  ^ Type    ^ Method            ^ Notes                                       ^
| id         | int     | GET, PUT, DELETE  | unique identifier of the object             |
| name       | string  | POST,PUT          | netarea's name, unique per hierarchy level  |
| type       | text    | POST, PUT         | area type like site, room etc.              |
| coord      | int     | POST, PUT         | coordinates of the area to show a map       |
| notes      | text    | POST, PUT         | further notes or description                |
| area_id    | int     | POST              | link to the predecessor in the area tree    |

[[start#objects|<< zurück]]