Attach access zone to entity, e.g. identifier or call number
Attaches access zone to identifier or call number.
Access zone provides access code that is send to Wiegand out when BOND lift adapter is used.
Path Parameters
- zone-uid integer required
Possible values:
>= 1
Unique Identifier for Access Zone Item
- application/json
Request Body required
entity object required
Call number information
type string requiredPossible values: [
call_number
,identifier
]Entity type
id integer requiredPossible values:
>= 1
and<= 9999989999
Call number or Identifier unique ID. When receiver will grant access, code from attached access zone will be sent to BOND lift controller.
- 200
- 400
- 401
- 403
OK
- 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
}
- No such access zone or entity
- 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 entity uid
- Wrong entity type
- Wrong zone uid
Schema
- error string
Error message
{
"error": true
}
{
"error": "Missed JSON body"
}
{
"error": "Wrong JSON body: no value for `param`"
}
{
"error": "Wrong JSON body: value `param` was of the wrong type"
}
{
"error": "Wrong JSON body: wrong entity.id"
}
{
"error": "Wrong JSON body: wrong entity.type"
}
{
"error": "Wrong JSON body: wrong zone-uid"
}
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"
}