Get User Entity
Returns detailed info about User
Path Parameters
- userUid 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
] - item_uid integer
- link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
- name string
- lock_number integer
- is_custom_user_access boolean
- info string
identifiers object[]
identifier_uid integerPossible values:
>= -1
UID for entities referenses. If value is
-1
, then it means that is no entity reference for this structureidentifier_owner object
name stringtype stringPossible values: [
owner
,guest
]identifier_type stringPossible values: [
card
,ukey
,inputCode
,face_id
,qr
,license_plate
]identifier_number string-
hex, number or face eiginvalue 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
]valid object
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 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 stored in the panel, such as apartments, identifiers, forward, and similar
uid_items integer[]Possible values:
>= -1
Array of UID for entities referenses.
link_ids uuid[]Array of LinkIDs for entities references
count integerThe number of values in the array
additional object
passes_left integerPossible values:
>= -1
if access is permanent - return
-1
valueapartments object[]
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 integertimeprofiles object[]
name stringtime_options object
is_all_day booleandate_from int64Unix Timestamp Date
date_to int64Unix Timestamp Date
repeat_options object
The model describes repeat option for
time
range in Timeprofilerepeat_enable booleanrepeat_format object
The model describes repeat format in Timeprofile
repeat_type stringPossible values: [
day
,week
,twoWeeks
,month
,year
,custom
]repeat_end object
date
key required ifdate
format was chosenformat stringPossible values: [
never
,date
]date int64Unix Timestamp Date
repeat_custom object
Only for
custom
repeat typerepeat_point_type stringPossible values: [
day
,week
,month
,year
]repeat_looper integerPossible values:
>= 1
and<= 1000
repeat_options object
oneOf- MOD1
- MOD2
- MOD3
stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
]format stringPossible values: [
dayNumbers
,parameterizedDay
]range object
oneOf- MOD1
- MOD2
integerPossible values:
>= 1
and<= 31
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]months integer[]Possible values:
>= 1
,<= 12
range object
week_order stringPossible values: [
first
,second
,third
,fourth
,fifth
,last
]day_type stringPossible values: [
MON
,TUE
,WED
,THU
,FRI
,SAT
,SUN
,WEEK_DAY
,DAY_OFF
]
{
"auth_factors": [
"face_id"
],
"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": "oae44848-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": "Wrong JSON body"
}
{
"error": "Wrong User uid"
}
Unauthorized request. Log In
- application/json
- Schema
- Example (from schema)
- Log In
Schema
- error string
{
"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": "Administrator rights required"
}
{
"error": "Administrator rights required"
}