Returns Identifier Entity
Returns Identifier Entity
Path Parameters
- identifierUid integer required
Possible values:
>= 1
Unique Id for physical/input code identifier
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
Schema
identifier_owner object
name stringtype stringPossible values: [
owner
,guest
]- identifier_type string
Possible values: [
card
,ukey
,inputCode
,face_id
,qr
] - identifier_number hex
- hex, number or face eiginvalue data in Base64.
- This param isn't required if you crete face identifier by uploading image.
- lock string
Possible values: [
first
,second
,all
] time object
is_permanent booleanfrom int64Unix Timestamp Date
to int64Unix Timestamp Date
passes object
is_permanent booleanmax_passes integerPossible values:
>= 1
apartment object
uid integerPossible values:
>= -1
UID for entities referenses. If value is
-1
, then it means that is no entity reference for this structurelogical_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
count integerThe number of values in the array
uid_items integer[]Possible values:
>= -1
Array of UID for entities referenses.
- link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
additional object
passes_left integerPossible values:
>= -1
if access is permanent - return
-1
value
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "123456ABCD",
"lock": "first",
"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
}
},
"time_profiles": {
"count": 4,
"uid_items": [
11,
13,
23,
42
]
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"additional": {
"passes_left": 3
}
}
Wrong Identifier uid
Log In
Administrator rights required