Create Access Zone
Creates Access Zone Entity.
Access zone provides access for proper floor when BOND lift adapter is used
- application/json
Request Body required
- name string
Access zone name
- code string
Possible values: Value must match regular expression
^((\d{1,39})|(([a-f0-9]{2}-){1,15}[a-f0-9]{2}))$
Access zone code. This code will be send to a BOND lift controller via wiegand out.
Can be represented in decimal or hex, according to identifier representation (
GET/POST /access/general/wiegand/type
)
- 200
- 400
- 401
- 403
The uid
value returned in the response can be used as the zone-uid
parameter in next requests:
GET/PATCH/DELETE /access/lift/zones/{zone-uid}
- to read/update/delete zone rulePOST/DELETE /access/lift/zones/{zone-uid}/identifier/{identifier-uid}
- to attach/detach zone rule to identifier
- application/json
- Schema
- Example (from schema)
- Example
Schema
- item_uid integer
Possible values:
>= -1
UID for entities references. If value is
-1
, then it means that is no entity reference for this structure
{
"item_uid": 3
}
{
"item_uid": 3
}
- Wrong area: must be a digit
- Access zone with same code already exists
- Missed json body or wrong param Response sample:
"error": "Wrong JSON body"
- Required field is not provided. Response sample:
"error": "Wrong JSON body: no value for `param`"
where param
- is a required field that was not provided
- Field was of the wrong type. Response sample:
"error": "Wrong JSON body: value `param` was of the wrong type"
where param
- is a field of the wrong type
- application/json
- Schema
- Example (from schema)
- Base
- No value
- Wrong param type
- Wrong code
- Duplicate zone
Schema
- error string
Error message
{
"error": true
}
{
"error": "Wrong JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
{
"error": "Wrong code"
}
{
"error": "Access zone with the same code already exists"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}
Administrator rights required. You are currently logged in with different user account. Log In with administrator rights
- application/json
- Schema
- Example (from schema)
- Admin Rights Required
Schema
- error string
Error message
{
"error": "Administrator rights required"
}
{
"error": "Administrator rights required"
}