Update Identifier Entity
Update Identifier Entity
Path Parameters
- identifier-uid integer required
Possible values:
>= 1
Unique Id for physical/input code identifier
- application/json
Request Body required
identifier_owner object required
Identifier owner information
name string requiredUser name
type string requiredPossible values: [
owner
,guest
]Identifier owner type
- identifier_type string required
Possible values: [
card
,ukey
,inputCode
,face_id
,qr
,license_plate
]Identifier type
- identifier_number string required
-
hex, number or face eigenvalue data in Base64 - This param ignored if you create face identifier by uploading image
-
hex or dec if identifier_type is card or ukey
-
dec if identifier_type is inputCode
-
uuid if identifier_type is qr
-
pattern for hex and dec - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})
-
- lock string required
Possible values: [
first
,second
,all
]Lock
valid object
Access restriction by time and passes
time object required
Restriction by time
is_permanent boolean requiredIf enabled Identifier will has permanent access by time
from int64Unix Timestamp Date
to int64Unix Timestamp Date
passes object required
Restriction by passes
is_permanent boolean requiredIf enabled Identifier will has permanent access by passes
max_passes integerPossible values:
>= 1
Max passes count. If Identifier is permanent this field is not required
- 200
- 400
- 401
- 403
OK
- Wrong Identifier uid
- Identifier with that type and number already exist
- Cannot create identifier with the same input code number as master code
- Cannot create identifier with same card number as master card
- You cannot create
face_id
identifier on this panel - Date
from
must be greater thanto
- application/json
- Schema
- Example (from schema)
- Wrong Identifier uid
- Identifier exists
- Duplicate master code
- Duplicate master card
- Cannot create face id
- Wrong face id data
- Invalid timeprofile settings
Schema
- error string
Error message
{
"error": true
}
{
"error": "Wrong Identifier uid"
}
{
"error": "Identifier with that type and number already exist"
}
{
"error": "Cannot create identifier with the same input code number as master code"
}
{
"error": "Cannot create identifier with same card number as master card"
}
{
"error": "You cannot create face_id identifier on this panel"
}
{
"error": "Wrong face_id image data"
}
{
"error": "Date `from` must be greater than `to`"
}
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"
}