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

==== netarea object ====

^ Method  ^ URL                                 ^ Notes                                                          ^
| GET     | /rest/{IF}/netarea                  | returns a list of all netareas                                 |
| GET     | /rest/{IF}/netarea/{id}             | Information about a single netarea                             |
| GET     | /rest/{IF}/netarea/{id}/netarea     | returns a list of all netareas below the selected in the tree  |
| GET     | /rest/{IF}/netarea/{id}/iparea      | returns the assigned ipareas                                   |
| GET     | /rest/{IF}/netarea/{id}/vlandomain  | returns the assigned vlandomains                               |
| GET     | /rest/{IF}/netarea/{id}/vlan        | returns a list of all vlans assigned to the netarea            |
| GET     | /rest/{IF}/netarea/{id}/ipnet       | returns a list of all ipnets assigned to the netarea           |

== 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                |
| notes       | text    | POST, PUT         | Description                                               |
| plancount   | int     | POST, PUT         | Number of planned users in the netarea                    |
| tcontact    | string  | POST, PUT         | name, UPN, etc. of the technical contact of this netarea  |
| area_id     | int     | POST              | link to the geographical area                             |
| netarea_id  | int     | POST              | link to the predecessor in the netarea-hierarchy          |

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