Get User Entity
Returns detailed info about User
Path Parameters
- user-uid integer required
Possible values:
>= 1
Unique Identifier for User Item
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
- auth_factors string[]
Possible values: [
face_id
,card
,input_code
,qr
,license_plate
]Auth factors list
- item_uid integer
User unique ID
- link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
- name string
User name
- lock_number integer
Lock number
- is_custom_user_access boolean
Use custom auth factors when enabled
- info string
Additional information
identifiers object[]
List of attached identifiers
identifier_uid integerPossible values:
>= -1
UID for entities references. If value is
-1
, then it means that is no entity reference for this structureidentifier_owner object
Identifier owner information
name stringUser name
type stringPossible values: [
owner
,guest
]Identifier owner type
identifier_type stringPossible 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 stringPossible 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
valueapartments object[]
List of attached apartments
apartment_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
apartment_name stringPossible values: Value must match regular expression
^\S(.*\S)?$
Name for the apartment, owner full name or apartment number usually used. Nonempty string without leading and trailing spaces
residents object
Optional information about tenants
count integerThe number living in the apartment
photo_path stringPhoto path for person photo in apartment book
Available only on AA-14
route_path stringRoute image for lift feature.
Available only on AA-14
item_uid integerApartment unique ID
timeprofiles object[]
List of attached timeprofiles
name stringTimeprofile name
time_options object
This model represents Timeprofile options
is_all_day booleanIs all day enabled
date_from int64Unix Timestamp Date
date_to int64Unix Timestamp Date
repeat_options object
The model describes repeat option for
time
range in Timeprofilerepeat_enable booleanIf repeat enabled
repeat_format object
The model describes repeat format in Timeprofile
repeat_type stringPossible values: [
day
,week
,twoWeeks
,month
,year
,custom
]Repeat type
repeat_end object
date
key required ifdate
format was chosenformat stringPossible values: [
never
,date
]Repeat end type
date int64Unix Timestamp Date
repeat_custom object
Only for
custom
repeat typerepeat_point_type stringPossible values: [
day
,week
,month
,year
]Repeat point type
repeat_looper integerPossible values:
>= 1
and<= 1000
Repeat looper
repeat_options object
Repeat options
oneOf- MOD1
- MOD2
- MOD3
stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
]Week days
format stringPossible values: [
dayNumbers
,parameterizedDay
]Format in month options
range object
Repeat range
oneOf- MOD1
- MOD2
integerPossible values:
>= 1
and<= 31
Dey of the month number
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]Week order
day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]Day type
months integer[]Possible values:
>= 1
,<= 12
List of months
range object
Parametrized day options used in complex time rule
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]Week order
day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]Day type
{
"auth_factors": [
"card"
],
"item_uid": 1,
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"name": "John Doe",
"lock_number": 1,
"is_custom_user_access": false,
"info": "Employee",
"identifiers": [
{
"identifier_uid": 3,
"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
}
}
],
"apartments": [
{
"apartment_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"apartment_name": "221B Baker Street",
"residents": {
"count": 3
},
"photo_path": "/api/v1/files?imagePath=apartment-1-1-1-1.jpg",
"route_path": "/api/v1/files?imagePath=route-1-1-1-1.webp",
"item_uid": 1
}
],
"timeprofiles": [
{
"name": "Work week",
"time_options": {
"is_all_day": true,
"date_from": 1540819272,
"date_to": 1540819272
},
"repeat_options": {
"repeat_enable": true,
"repeat_format": {
"repeat_type": "day",
"repeat_end": {
"format": "date",
"date": 1540819272
},
"repeat_custom": {
"repeat_point_type": "week",
"repeat_looper": 5,
"repeat_options": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
]
}
}
}
}
]
}
{
"auth_factors": [
"face_id",
"input_code"
],
"name": "John Doe",
"item_uid": 1,
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"lock_number": 1,
"is_custom_user_access": false,
"info": "Employee",
"apartments": [
{
"apartment_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"apartment_name": "221B Baker Street",
"item_uid": 1,
"residents": {
"count": 3
},
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3"
}
],
"identifiers": [
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"item_uid": 1,
"lock": "first",
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"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": "eae44848-5e81-4861-8e63-861d9bd4ebb3"
},
"time_profiles": {
"uid_items": [
11,
13,
23,
42
],
"link_ids": [
"eae44848-5e81-4861-8e63-861d9bd4ebb3",
"eae44848-5e81-4861-8e63-861d9bd4ebb3",
"eae44848-5e81-4861-8e63-861d9bd4ebb3",
"eae44848-5e81-4861-8e63-861d9bd4ebb3"
],
"count": 4
},
"additional": {
"passes_left": 3
}
}
],
"timeprofiles": [
{
"name": "One day",
"item_uid": 1,
"repeat_options": {
"repeat_enable": false
},
"time_options": {
"is_all_day": true,
"date_to": 1601920800,
"date_from": 1601884800
}
}
]
}
Wrong User uid
- application/json
- Schema
- Example (from schema)
- Wrong User uid
Schema
- error string
Error message
{
"error": "Wrong JSON body"
}
{
"error": "Wrong User 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"
}