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 UIDs

Path Parameters

• apartmentUid integer required

  Possible values: >= 1

  Unique Identifier for Item

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• apartment_address object

  building int32

  Possible values: >= 1 and <= 999

  Building number

  unit int32

  Possible values: >= 1 and <= 99

  Unit number

  floor int32

  Possible values: >= 1 and <= 99

  Floor number

  room int32

  Possible values: >= 1 and <= 99

  Room number

• apartment_name string
• residents object

  count integer

{
  "apartment_address": {
    "building": 1,
    "unit": 1,
    "floor": 1,
    "room": 1
  },
  "apartment_name": "221B Baker Street",
  "residents": {
    "count": 3
  }
}

{
  "apartment_address": {
    "building": 1,
    "unit": 1,
    "floor": 1,
    "room": 1
  },
  "apartment_name": "221B Baker Street",
  "residents": {
    "count": 3
  }
}

Wrong apartment uid

Log In

Loading...