๐ชZones
This page provides a description of the available API routes for managing zones.
The zone represents visual representation of a specific area, such as a room, terrace, or any other defined space. It contains the layout, dimensions, and arrangement of objects within that area.
The data model for zone is represented by Zone
class.
API methods
Get zones
GET
http://{server-address}/zones
Returns all zones that matches query parameters. Result is of type QueryResult<Zone>
.
Query Parameters
Name | Type | Description |
---|---|---|
Name | string | Supports NData syntax. |
DefaultFiscalName | string | Supports NData syntax. |
$skip | int | Pagination property. Describing number of records to skip from beginning of result collection. |
$take | int | Pagination property. Maximum count of items to be returned. |
$sort | string[] | Comma separated list of property names. Please see NData syntax. |
$count | bool | If set to |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Get zone by name
GET
http://{server-address}/zones/{name}
Result is of type Zone.
Path Parameters
Name | Type | Description |
---|---|---|
name* | string | Unique zone name. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Create zone
POST
http://{server-address}/zones
Creates new zone. Result is of type Zone.
Required rights
Authorized user must have ZoneCreate
right assigned.
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | Zone | Zone model to create |
Create or update zone
PUT
http://{server-address}/zones/{name}
Updates existing or creates new zone. Result is of type Zone.
Required rights
Authorized user must have assigned ZoneCreate
or ZoneUpdate
right.
Path Parameters
Name | Type | Description |
---|---|---|
name* | string | Unique zone name. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Request Body
Name | Type | Description |
---|---|---|
(body)* | Zone | Zone model to create or update. |
Delete zone by name
DELETE
http://{server-address}/zones/{name}
Required rights
Authorized user must have ZoneDelete
right assigned.
Path Parameters
Name | Type | Description |
---|---|---|
name* | string | Unique zone name. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Authorization header with authorization token. |
Last updated