Update multiple Identifier items by link_id
Create or Update multiple Identifier items.
This request is used by Link
management system. Link adds to each identifier and apartment link_id
and apartment_link_id
to link them together.
They can be added to multiple panels and removed by link_id
param using POST /access/identifiers/link/delete
- application/json
Request Body required
- list_items object[]
Identifier with link ID
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Created
- Updated
- Face id is not supported
- Face id exceeded
- Identifiers exceeded
- Bad B A S E64 face image file
- Face image not recognized
- Invalid time rule settings
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": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "created"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "updated"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": false,
"extended_info": "face_id_not_supported"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": false,
"extended_info": "number_of_face_identifiers_exceeded"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": false,
"extended_info": "number_of_identifiers_exceeded"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": false,
"extended_info": "bad_base_64_image_file"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": false,
"extended_info": "face_has_not_recognized"
}
]
}
{
"result": [
{
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"success": true,
"extended_info": "invalid_time_rules_settings"
}
]
}
- 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"
}