Get the list of attached apartments

Return the list of attached apartments

Path Parameters

• user-id integer required

  Possible values: >= 1

  Unique Identifier for User Item

Query Parameters

• limit integer required

  Possible values: <= 1000

  Number of items. Value by default is 10

• page_number integer required

  Possible values: >= 1

  Page number

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• items object[]

  List items

  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 object

  Unique entity set by the server to bind some parameters with each other

  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.

• options object

  Available pagination options

  pagination object

  Available pagination options for tables

  total_items integer

  The total number of items found and reflected across all pages

  items_limit integer

  Possible values: <= 1000

  Limiting the display of the amount of data for one page

  total_pages integer

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

{
  "items": [
    {
      "id": 3,
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "name": "221B Baker Street"
    }
  ],
  "options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 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...