Create/update multiple User Entities with `link_id'
Create/update multiple User Entities with link_id.
If entity doesn't exist in system - it will be created. If user with same link_id or name already exists - it will be updated.
has_dublicates - if user with the same name already exists, has_dublicates will be in true condition
To identify users, use info` field.
If some of the attached entities do not exist, the user will still be created or updated,
but the response will include warnings in the extended_info field with one or more of the following error codes:
bound_apartment_doesnt_exist- referenced apartment link_id not foundbound_time_profile_doesnt_exist- referenced time profile link_id not foundbound_identifier_doesnt_exist- referenced identifier link_id not foundbound_kone_rule_doesnt_exist- referenced KONE rule link_id not found
- application/json
Request Body
- list_items object[] required
List of users
Responses
- 200
- 400
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
- result object[]
List of operation results
{
"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",
"has_dublicates": false
},
{
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"success": true,
"extended_info": "updated",
"has_dublicates": false
},
{
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"success": true,
"extended_info": "bound_apartment_doesnt_exist",
"has_dublicates": false
},
{
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"success": true,
"extended_info": "bound_time_profile_doesnt_exist",
"has_dublicates": false
},
{
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"success": true,
"extended_info": "bound_identifier_doesnt_exist",
"has_dublicates": false
},
{
"link_id": "eae44848-5e81-4861-8e63-861d9bd4ebb3",
"success": true,
"extended_info": "bound_kone_rule_doesnt_exist",
"has_dublicates": false
}
]
}
- 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"
}
Loading...