Skip to main content

Get multiple Apartment Entities with link_id.

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 namesee the list of available fields in filter.available_fields[].field_name
    valuesee the list of available values in filter.available_fields[].options object, may be missing
    compare operatorsee the list of available operators in filter.available_fields[].compare_operators array
    Compare operatorsDescriptionExample
    eqEqualname eq 'Sherlock Holmes'
    gtGreater thanbuilding gt 10
    ltLess thanbuilding lt 10
    nqNot equalname nq 'Sherlock Holmes'
    geGreater than or equalfloor ge 5
    leLess than or equalfloor le 5
    Logical operators
    andlogical ANDfloor le 10 and floor gt 3
    orlogical ORfloor le 3 or floor gt 10
    notlogical NOTnot floor le 3
    group operations
    ()group by priority(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10
Responses

OK


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, 20, 25, 30, 40, 50]

    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

  • filter object

    Available fields

    field namecompare operatorstypevalues
    apartment_nameeq, nqstring
    residentseq, nq, lt, gt, ge, leinteger
    buildingeq, nq, lt, gt, ge, leinteger range1..9999
    uniteq, nq, lt, gt, ge, leinteger range0..99
    flooreq, nq, lt, gt, ge, leinteger range0..98
    roomeq, nq, lt, gt, ge, leinteger range0..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

  • available_values object[]

    Possible values: >= 1

    This model provide filter available values

  • 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

Loading...