Delete multiple Apartment Entities with link_id
Delete multiple Apartment Entities with link_id
.
If apartment with provided link_id
exists - it will be removed. If entity doesn't exist in system - operation will be ignored
- application/json
Request Body required
- link_ids uuid[]
array of ids from Link
Responses
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
result object[]
resulting array of ids
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
success booleanstatus of operation
extended_info stringPossible 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": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "deleted"
},
{
"link_id": "ca99a8c3-fb47-4d6b-bf6c-2b9bf58384ea",
"success": false,
"extended_info": "deleted"
}
]
}
- 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 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"
}
Loading...