Create Apartment Entity
Creates Apartment Entity. The uid
value returned in the response can be used as the apartment-uid
parameter in next requests:
GET /apartment/item/{apartment-uid}
to get detailed apartment informationPOST /apartment/item/{apartment-uid}/identifier/{identifier-uid}
to attach identifier to apartmentPOST /apartment/item/{apartment-uid}/photo
to add or update apartment's image profile photo
- 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
- application/json
- Schema
- Example (from schema)
- Example
Schema
- uid integer
Possible values:
>= -1
UID for entities references. If value is
-1
, then it means that is no entity reference for this structure
{
"uid": 3
}
{
"uid": 3
}
Validation error or required fields are not provided
- application/json
- Schema
- Example (from schema)
Schema
- MOD1
- MOD2
- error string
Error message
- error string
Error message
{
"error": "Wrong Logical Address"
}
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"
}