Get Apartments list

Return Apartments entities detailed list with used pagination, filter, and sort options

Query Parameters

• limit integer required

  Possible values: [10, 20, 30, 50]

  Default value: 10

  Number of items. Value by default is 10

• pageNumber integer required

  Possible values: >= 1

  Default value: 1

  Page number

• sortField string

  Field name (JSON Key in item entity)

• sortType string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_items object[]
• list_option object

  Available options for sorting, filtering and pagination of lists

  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: [10, 25, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  Possible values: >= 1

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  sort object

  field string

  asc boolean

  available_fields string[]

  Possible values: [apartment_address, apartment_name, residents]

{
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 3
      },
      "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
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "apartment_name",
      "asc": true,
      "available_fields": [
        "apartment_address"
      ]
    }
  }
}

{
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 3
      },
      "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
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "apartment_name",
      "asc": true,
      "available_fields": [
        "apartment_address",
        "apartment_name",
        "residents"
      ]
    }
  }
}

• Wrong pagination options
• Wrong sort options
• Wrong filter options

Log In

Loading...