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_option object
Available options for sorting, filtering and pagination of lists
pagination object
Available pagination options for tables
total_items integerThe total number of items found and reflected across all pages
items_limit integerPossible values: [
10
,20
,30
,50
]Limiting the display of the amount of data for one page
total_pages integerThe number of pages that hold the requested data
current_page integerPossible values:
>= 1
Current page number
filter object
Available filter sets for apartments
anyOf- MOD1
- MOD2
- MOD3
filter_field stringField available for filtering
filter_type stringPossible values: [
equal
]Available filtering type, only equal here
filter_format stringData format, only string here
filter_value stringBaker Street
filter_field stringPossible values: [
apartment_address
]Field available for filtering
filter_type stringPossible values: [
equal
]Available filter type, only equal here
filter_format stringPossible values: [
string
]Available filter format, only string here
filter_value stringFilter value
filter_field stringPossible values: [
residents
]Available filter type
filter_type stringPossible values: [
less
,equal
,more
]Field available for filtering
filter_format stringPossible values: [
integer
]Available filter format, only integer here
filter_value integerReturns apartments with residents count greater then six
sort object
Available sorting options for the selected table
field stringSorting field name
asc booleanSort direction
available_fields string[]Available for sorting fields names
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
result object[]
List of operation statuses
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
success booleanOperation status
extended_info stringPossible 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 booleanParameter describes if user with the same name already exists
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "created",
"has_dublicates": false
}
]
}
{
"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:where
"error": "Wrong JSON body: no value for `param`"
param
- is a required field that was not provided - Field was of the wrong type.
Response sample:where
"error": "Wrong JSON body: value `param` was of the wrong type"
param
- is a field of the wrong type
- application/json
- Schema
- Example (from schema)
- Base
- Missed param
- Wrong param type
Schema
- error string
Error message
{
"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"
}
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"
}