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 cound and UIDs
forward UIDs

Path Parameters

apartmentUid integer required
Possible values: >= 1
Unique Identifier for Item

Responses

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 integer
Possible values: >= 1 and <= 9999
Building number
unit integer
Possible values: <= 99
Unit number
floor integer
Possible values: <= 98
Floor number
room integer
Possible values: <= 99
Room number
apartment_name string
Name for the apartment, owner full name or apartment number usually used
residents object
Optional information about tenants
count integer
The number living in the apartment
link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
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
count integer
The number of values in the array
uid_items integer[]
Possible values: >= -1
Array of UID for entities referenses.
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
count integer
The number of values in the array
uid_items integer[]
Possible values: >= -1
Array of UID for entities referenses.
forward object
exist boolean
uid_item integer
Possible values: >= -1
UID for entities referenses. If value is -1, then it means that is no entity reference for this structure

{
  "apartment_address": {
    "building": 1,
    "unit": 1,
    "floor": 1,
    "room": 1
  },
  "apartment_name": "221B Baker Street",
  "residents": {
    "count": 3
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "physicals": {
      "count": 4,
      "uid_items": [
        11,
        13,
        23,
        42
      ]
    },
    "input_numbers": {
      "count": 4,
      "uid_items": [
        11,
        13,
        23,
        42
      ]
    }
  },
  "forward": {
    "exist": true,
    "uid_item": 3
  }
}

{
  "apartment_address": {
    "building": 1,
    "unit": 1,
    "floor": 1,
    "room": 1
  },
  "apartment_name": "221B Baker Street",
  "residents": {
    "count": 3
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "identifiers": {
    "physicals": {
      "count": 4,
      "uid_items": [
        11,
        13,
        23,
        42
      ]
    },
    "input_numbers": {
      "count": 4,
      "uid_items": [
        11,
        13,
        23,
        42
      ]
    }
  },
  "forward": {
    "exist": true,
    "uid_item": 3
  }
}

Get Apartment Entity detailed information​

Get Apartment Entity detailed information