Skip to main content

Create/update multiple Apartment Entities with link_id.

If entity doesn't exist in system - it will be created. If apartment with same link_id or logical address already exists - it will be updated.

Request Body required
  • list_items object[] required

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

    anyOf

  • 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

  • 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

Responses

OK


Schema
  • result object[]

    List of operation statuses

  • link_id uuid

    Unique entity set by the server to bind some parameters with each other. By default return null value

  • success boolean

    Operation status

  • extended_info string

    Possible values: [created, updated, deleted, entity_not_found, has_dublicates, number_taken_by_another_identifier, bad_base_64_image_file, face_has_not_recognized, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded, invalid_time_rules_settings]

    Entity state information result

  • has_dublicates boolean

    Parameter describes if user with the same name already exists

Loading...