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
page_number integer required
Possible values: >= 1
Default value: 1
Page number
order_by string
sorting expression:

[field name 1], [field name 2]... <order (asc or desc)>

filter string

Filtering expression:

[field name] [compare operator] [value] <logical operator>...


field name	see the list of available fields in `filter.available_fields[].field_name`
value	see the list of available values in `filter.available_fields[].options object`, may be missing
compare operator	see the list of available operators in `filter.available_fields[].compare_operators array`

Compare operators	Description	Example
eq	Equal	name eq 'Sherlock Holmes'
gt	Greater than	building gt 10
lt	Less than	building lt 10
nq	Not equal	name nq 'Sherlock Holmes'
ge	Greater than or equal	floor ge 5
le	Less than or equal	floor le 5
Logical operators
and	logical AND	floor le 10 and floor gt 3
or	logical OR	floor le 3 or floor gt 10
not	logical NOT	not floor le 3
group operations
()	group by priority	(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10

Responses

application/json

Schema
Example (from schema)
Example

Schema

list_items object[]
list of apartments

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

filter object

Available fields

field name	compare operators	type	values
apartment_name	eq, nq	string
residents	eq, nq, lt, gt, ge, le	integer
building	eq, nq, lt, gt, ge, le	integer range	1..9999
unit	eq, nq, lt, gt, ge, le	integer range	0..99
floor	eq, nq, lt, gt, ge, le	integer range	0..98
room	eq, nq, lt, gt, ge, le	integer range	0..99

available_filtering boolean

can be filtered

is_filtered boolean

filter is applied

available_fields object[]

list of field that can be used in filtering

field_name string

compare_operators string[]

Possible values: [eq, gt, lt, nq, ge, le]

data_type string

Possible values: [string, integer, timestamp]

options object

anyOf

MOD1
MOD2
MOD3
MOD4

available_values object[]

Possible values: >= 1

This model provide filter available values

available_range integer[]

Possible values: >= 2, <= 2

This model provide filter integer range

has_date boolean

Default value: false

true - has date, false - doesn't

has_time boolean

Default value: false

true - has time, false - doesn't

has_milliseconds boolean

Default value: false

true - has milliseconds, false - doesn't

sort object

Available sorting options for the selected table

is_sorted boolean

true - sorted, false - unsorted

order string

Possible values: [asc, desc]

sorting order, asc - ascending, desc - descending

available_fields string[]

Possible values: [apartment_name, apartment_address, residents]

Available for sorting fields names

{
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 3
      },
      "item_uid": 3,
      "identifiers": {
        "physicals": {
          "count": 3,
          "uid_items": [
            1
          ]
        },
        "input_numbers": {
          "count": 3,
          "uid_items": [
            1
          ]
        }
      },
      "forward": {
        "count": 3
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "category",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "string",
              0
            ]
          }
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "apartment_name"
      ]
    }
  }
}

{
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 3
      },
      "item_uid": 3,
      "identifiers": {
        "physicals": {
          "count": 3,
          "uid_items": [
            1
          ]
        },
        "input_numbers": {
          "count": 3,
          "uid_items": [
            1
          ]
        }
      },
      "forward": {
        "count": 3
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "apartment_name",
          "compare_operators": [
            "eq",
            "nq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "any string"
            ]
          }
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "apartment_name",
        "residents",
        "apartment_address"
      ]
    }
  }
}

Wrong pagination limit
Wrong pagintation page number
Wrong sort field
Wrong sort type
Wrong filter options

application/json

Schema
Example (from schema)
Wrong pagination limit

Schema

error string
error type/info

{
  "error": true
}

{
  "error": "Wrong pagination limit"
}

application/json

Schema
Example (from schema)
Example

Schema

error string
error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}