Get Apartment Entity detailed information
Returns Apartment Entity detailed information.
Base Apartment Entity properties:
- apartment logical address
- apartment name
- link_id
Additional linked properties:
- identifiers count and UIDs
- input numbers count and UIDs
- forward rules quantity
Path Parameters
- apartmentUid integer required
Possible values:
>= 1
Unique Identifier for Item
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
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 int32Possible values:
>= 1
and<= 9999
Building number
unit int32Possible values:
<= 99
Unit number
floor int32Possible values:
<= 98
Floor number
room int32Possible 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
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 referenses.
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 referenses.
count integerThe number of values in the array
forward object
forward rules
count integerForward rules quantity
{
"apartment_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"apartment_name": "221B Baker Street",
"residents": {
"count": 3
},
"identifiers": {
"physicals": {
"uid_items": [
11,
13,
23,
42
],
"count": 4
},
"input_numbers": {
"uid_items": [
11,
13,
23,
42
],
"count": 4
}
},
"forward": {
"count": 1
}
}
{
"apartment_address": {
"building": 1,
"unit": 1,
"floor": 1,
"room": 1
},
"apartment_name": "221B Baker Street",
"residents": {
"count": 3
},
"identifiers": {
"physicals": {
"uid_items": [
11,
13,
23,
42
],
"count": 4
},
"input_numbers": {
"uid_items": [
11,
13,
23,
42
],
"count": 4
}
},
"forward": {
"count": 0
}
}
Provided wrong apartmentUid
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
error type/info
{
"error": "Wrong Logical Address"
}
{
"error": "Wrong apartment uid"
}
Log In
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
error message
{
"error": "Log In"
}
{
"error": "Log In"
}