Get Identifier Entity
Returns detailed info about Identifier
Path Parameters
- identifier-uid integer required
Possible values:
>= 1
Unique Id for physical/input code identifier
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
identifier_owner object
Identifier owner information
name stringUser name
type stringPossible values: [
owner
,guest
]Identifier owner type
- identifier_type string
Possible values: [
card
,ukey
,inputCode
,face_id
,qr
,license_plate
]Identifier type
- identifier_number string
-
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
Possible values: [
first
,second
,all
]Lock
valid object
Access restriction by time and passes
time object
Restriction by time
is_permanent booleanIf enabled Identifier will has permanent access by time
from int64Unix Timestamp Date
to int64Unix Timestamp Date
passes object
Restriction by passes
is_permanent booleanIf 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
apartment object
Apartment info
uid integerPossible values:
>= -1
UID for entities references. If value is
-1
, then it means that is no entity reference for this structurelink_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
logical_address object
Logical address - an entity defines the device/user address in the address hierarchy and is used during a call, issuing identifiers, creating call forwarding rules etc.
building integerPossible values:
>= 1
and<= 9999
Building number
unit integerPossible values:
<= 99
Unit number
floor integerPossible values:
<= 98
Floor number
room integerPossible values:
<= 99
Room number
time_profiles object
Model used to providing array of UIDs of various enumerated entities are stored in the panel, such as apartments, identifiers, forward, and similar with
count
paramuid_items integer[]Possible values:
>= -1
Array of UID for entities references
link_ids uuid[]Array of LinkIDs for entities references
count integerThe number of values in the array
additional object
This model describes information about number of remaining passes for the identifier
passes_left integerPossible values:
>= -1
Remaining passes. If access is permanent - return
-1
value
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"lock": "first",
"valid": {
"time": {
"is_permanent": false,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": false,
"max_passes": 3
}
},
"apartment": {
"uid": 3,
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"logical_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
}
},
"time_profiles": {
"uid_items": [
11,
13,
23,
42
],
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b1",
"91c615e3-1040-4815-8ecb-039a18b756b2",
"91c615e3-1040-4815-8ecb-039a18b756b3",
"91c615e3-1040-4815-8ecb-039a18b756b4"
],
"count": 4
},
"additional": {
"passes_left": 3
}
}
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"lock": "first",
"valid": {
"time": {
"is_permanent": false,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": false,
"max_passes": 3
}
},
"apartment": {
"uid": 3,
"logical_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
},
"time_profiles": {
"uid_items": [
11,
13,
23,
42
],
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5",
"91c615e3-1040-4815-8ecb-039a18b756b5",
"91c615e3-1040-4815-8ecb-039a18b756b5"
],
"count": 4
},
"additional": {
"passes_left": 3
}
}
Wrong Identifier uid
- application/json
- Schema
- Example (from schema)
- Wrong Identifier uid
Schema
- error string
Error message
{
"error": "Wrong JSON body"
}
{
"error": "Wrong Identifier 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"
}