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
• UIDs

Path Parameters

• apartment-id integer required

  Possible values: >= 1

  Unique Identifier for Apartment Item

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• 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

• name string

  Possible values: <= 100 characters

  Name for the apartment, owner full name or apartment number usually used. Nonempty string.

• id integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

• link_id uuid

  Possible values: <= 36 characters

  Unique entity set by the server to bind some parameters with each other. By default return null value

• references_count object

  list of the number of links

  identifiers integer

  Count of identifiers attached to the apartment

  users integer

  Count of users attached to the apartment

{
  "address": {
    "building": 1,
    "unit": 1,
    "floor": 1,
    "room": 1
  },
  "name": "221B Baker Street",
  "id": 3,
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "references_count": {
    "identifiers": 1,
    "users": 1
  }
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...