Get Apartment Entity detailed information
Returns Apartment Entity detailed information.
Base Apartment Entity properties:
- apartment logical address
- apartment name
Additional linked properties:
- identifiers count and UIDs
- input numbers count and UIDs
- forward UIDs
Path Parameters
- apartment-uid integer required
Possible values:
>= 1
Unique Identifier for Apartment Item
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example
- Example A A-14
Schema
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 string
Possible 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 string
Photo path for person photo in apartment book
Available only on AA-14
- route_path string
Route image for lift feature.
Available only on AA-14
identifiers object
Types of associated identifiers (cards, codes, etc.)
physicals: card, UKEY, face_id
input_numbers: code entered on the keyboard
physicals 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
input_numbers 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
forward object
The model represents information about entity presence in system
uid_item integerPossible values:
>= -1
UID for entities references. If value is
-1
, then it means that is no entity reference for this structureexist booleanParameters describes if entity is present in system
tenants object[]
List of tenants
name stringTenant name
id integerApartment tenant ID
owner_type stringOwner type
{
"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",
"identifiers": {
"physicals": {
"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
},
"input_numbers": {
"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
}
},
"forward": {
"uid_item": 3,
"exist": true
},
"tenants": [
{
"name": "John Doe",
"id": 1,
"owner_type": "owner"
}
]
}
{
"apartment_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"apartment_name": "221B Baker Street",
"residents": {
"count": 3
},
"identifiers": {
"physicals": {
"count": 4,
"uid_items": [
11,
13,
23,
42
],
"link_ids": [
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e"
]
},
"input_numbers": {
"count": 4,
"uid_items": [
11,
13,
23,
42
],
"link_ids": [
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e"
]
}
},
"forward": {
"exist": true,
"uid_item": 3
}
}
{
"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",
"identifiers": {
"physicals": {
"uid_items": [
11,
13,
23,
42
],
"count": 4,
"link_ids": [
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e"
]
},
"input_numbers": {
"uid_items": [
11,
13,
23,
42
],
"count": 4,
"link_ids": [
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e",
"8e4c043b-12f8-4863-81b5-529727f6bf6e"
]
}
},
"forward": {
"exist": true,
"uid_item": 3
}
}
Provided wrong apartment-uid
- application/json
- Schema
- Example (from schema)
- Wrong uid
Schema
- error string
Error message
{
"error": "Wrong Logical Address"
}
{
"error": "Wrong apartment 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"
}