Get Apartments list

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

Query Parameters

• limit integer

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

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

• sort_field string

  Field name (JSON Key in item entity)

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options for Apartment

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example
• Example A A-14 F B

---

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 filter sets for apartments

  oneOf

  • MOD1
  • MOD2
  • MOD3

  ---

  filter_field string

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filtering type, only equal here

  filter_format string

  Data format, only string here

  filter_value string

  Baker Street

  filter_field string

  Possible values: [apartment_address]

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filter type, only equal here

  filter_format string

  Possible values: [string]

  Available filter format, only string here

  filter_value string

  Filter value

  filter_field string

  Possible values: [residents]

  Available filter type

  filter_type string

  Possible values: [less, equal, more]

  Field available for filtering

  filter_format string

  Possible values: [integer]

  Available filter format, only integer here

  filter_value integer

  Returns apartments with residents count greater then six

  sort object

  Available sorting options for the selected table

  field string

  Sorting field name

  asc boolean

  Sort direction

  available_fields string[]

  Available for sorting fields names

{
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221A Baker Street",
      "residents": {
        "count": 3
      },
      "item_uid": 1,
      "identifiers": {
        "physicals": {
          "count": 0,
          "uid_items": []
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "forward": {
        "count": 5
      }
    },
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 2
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 4
      },
      "item_uid": 2,
      "identifiers": {
        "physicals": {
          "count": 0,
          "uid_items": []
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "forward": {
        "count": 5
      }
    },
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 3
      },
      "apartment_name": "221C Baker Street",
      "residents": {
        "count": 1
      },
      "item_uid": 3,
      "identifiers": {
        "physicals": {
          "count": 0,
          "uid_items": []
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "forward": {
        "count": 5
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "apartment_name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Baker Street"
    },
    "sort": {
      "field": "apartment_name",
      "asc": true,
      "available_fields": [
        "apartment_name"
      ]
    }
  }
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "apartment_name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Baker Street",
      "available_filtering": true,
      "available_fields": [
        "apartment_address"
      ],
      "is_filtered": true
    },
    "sort": {
      "asc": true,
      "field": "apartment_address",
      "available_fields": [
        "apartment_name",
        "apartment_address",
        "residents"
      ]
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "apartment_name": "202 Baker Street",
      "apartment_address": {
        "floor": 1,
        "unit": 1,
        "building": 1,
        "room": 1
      },
      "forward": {
        "exist": false
      },
      "identifiers": {
        "physicals": {
          "count": 1,
          "uid_items": [
            1
          ]
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "residents": {
        "count": 1
      }
    },
    {
      "item_uid": 2,
      "apartment_name": "203 Baker Street",
      "apartment_address": {
        "floor": 1,
        "unit": 1,
        "building": 1,
        "room": 2
      },
      "forward": {
        "exist": false
      },
      "identifiers": {
        "physicals": {
          "count": 1,
          "uid_items": [
            2
          ]
        },
        "input_numbers": {
          "count": 1,
          "uid_items": [
            3
          ]
        }
      },
      "residents": {
        "count": 1
      }
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "apartment_name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Baker Street",
      "available_filtering": true,
      "available_fields": [
        "apartment_address"
      ],
      "is_filtered": true
    },
    "sort": {
      "asc": true,
      "field": "apartment_address",
      "available_fields": [
        "apartment_name",
        "apartment_address",
        "residents"
      ]
    }
  },
  "list_items": [
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 1
      },
      "apartment_name": "221A Baker Street",
      "residents": {
        "count": 3
      },
      "item_uid": 1,
      "photo_path": "/api/v1/files?imagePath=apartment-1-1-1-1.jpg",
      "route_path": "/api/v1/files?imagePath=route-1-1-1-1.webp",
      "identifiers": {
        "physicals": {
          "count": 0,
          "uid_items": []
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "forward": {
        "count": 5
      }
    },
    {
      "apartment_address": {
        "building": 1,
        "unit": 1,
        "floor": 1,
        "room": 2
      },
      "apartment_name": "221B Baker Street",
      "residents": {
        "count": 4
      },
      "item_uid": 2,
      "photo_path": "/api/v1/files?imagePath=apartment-1-1-1-2.jpg",
      "route_path": "/api/v1/files?imagePath=route-1-1-1-2.webp",
      "identifiers": {
        "physicals": {
          "count": 0,
          "uid_items": []
        },
        "input_numbers": {
          "count": 0,
          "uid_items": []
        }
      },
      "forward": {
        "count": 5
      }
    }
  ]
}

Base errors for all entities

• Wrong pagination limit
• Wrong page number
• Wrong filter type
• Wrong filter field
• Wrong filter format
• Wrong filter value
• Wrong sort type
  Errors appeared only in log entities:
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
  Errors appeared in other entities:
• Wrong sort field

application/json

• Schema
• Example (from schema)
• Pagination Limit
• Pagination Page Number
• Sort type
• Sort field
• Filter type
• Filter field
• Filter value
• Filter format
• Time format
• Time range

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...