Zones
This page provides a description of the available API routes for managing zones.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing zones.
Last updated
Was this helpful?
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 class.
GET
http://{server-address}/zones
Returns all zones that matches query parameters. Result is of type .
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 true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
Authorization*
string
Authorization header with authorization token.
GET
http://{server-address}/zones/{name}
name*
string
Unique zone name.
Authorization*
string
Authorization header with authorization token.
POST
http://{server-address}/zones
Required rights
Authorization*
string
Authorization header with authorization token.
(body)*
Zone
Zone model to create
PUT
http://{server-address}/zones/{name}
Required rights
name*
string
Unique zone name.
Authorization*
string
Authorization header with authorization token.
(body)*
Zone
Zone model to create or update.
DELETE
http://{server-address}/zones/{name}
Required rights
name*
string
Unique zone name.
Authorization*
string
Authorization header with authorization token.
Result is of type .
Creates new zone. Result is of type .
Authorized user must have ZoneCreate
assigned.
Updates existing or creates new zone. Result is of type .
Authorized user must have assigned ZoneCreate
or ZoneUpdate
.
Authorized user must have ZoneDelete
assigned.