Update Apartment Entity information
Update Apartment Entity base information
Path Parameters
- apartment-uid integer required
Possible values:
>= 1
Unique Identifier for Apartment Item
- application/json
Request Body required
apartment_address object required
Logical address - an entity defines the device/user address in the address hierarchy and is used during a call, issuing identifiers, creating call forwarding rules etc.
building integerPossible values:
>= 1
and<= 9999
Building number
unit integerPossible values:
<= 99
Unit number
floor integerPossible values:
<= 98
Floor number
room integerPossible values:
<= 99
Room number
- apartment_name string required
Possible values: Value must match regular expression
^\S(.*\S)?$
Name for the apartment, owner full name or apartment number usually used. Nonempty string without leading and trailing spaces
residents object required
Optional information about tenants
count integer requiredThe number living in the apartment
- photo_path string
Photo path for person photo in apartment book
Available only on AA-14
- route_path string
Route image for lift feature.
Available only on AA-14
- 200
- 400
- 401
- 403
OK
- Invalid name
- Wrong Logical Address
- Missed json body or wrong param
- Apartment with that Logical Address already exist
- Wrong apartment uid 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
- No value
- Wrong param type
- Wrong Address
- Invalid name
- Already exists
- Wrong uid
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"
}
{
"error": "Wrong Logical Address"
}
{
"error": "Invalid name"
}
{
"error": "Apartment with that Logical Address already exist"
}
{
"error": "Wrong apartment uid"
}
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"
}