Create/update multiple Apartment Entities with `link_id`

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.

application/json

Request Body required

list_items object[] required
list of apartments

list_options 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 required

can be filtered

is_filtered boolean required

filter is applied

available_fields object[] required

list of field that can be used in filtering

field_name string required

data_type string required

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 required

true - sorted, false - unsorted

order string

Possible values: [asc, desc]

sorting order, asc - ascending, desc - descending

available_fields string[] required

Possible values: [apartment_name, apartment_address, residents]

Available for sorting fields names

Responses

application/json

Schema
Example (from schema)
Example

Schema

result object[]
resulting array of ids
link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
success boolean
status of operation
extended_info string
Possible values: [created, updated, deleted, entity_not_found, number_taken_by_another_identifier, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded]
Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "0bde56e8-2feb-428a-a82f-e51d2e3692ac",
      "success": true,
      "extended_info": "created"
    },
    {
      "link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
      "success": true,
      "extended_info": "updated"
    }
  ]
}

Missed json body or wrong param. Response sample:
```
  "error": "Wrong JSON body"
```
Required field is not provided. Response sample:
```
  "error": "Wrong JSON body: no value for `param`"
```
where param - is a required field that was not provided
Field was of the wrong type. Response sample:
```
  "error": "Wrong JSON body: value `param` was of the wrong type"
```
where param - is a field of the wrong type

application/json

Schema
Example (from schema)
Base
Missed param
Wrong param type

Schema

error string
error type/info

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Create/update multiple Apartment Entities with link_id​

Available fields​

Create/update multiple Apartment Entities with `link_id`

Available fields