Create Apartment Entity

Creates Apartment Entity. The uid value returned in the response can be used as the apartmentUid parameter in next requests:

• GET /apartment/item/{apartmentUid} to get detailed apartment information
• POST /apartment/item/{apartmentUid}/identifier/{identifierUid} to attach identifier to apartment
• POST /apartment/item/{apartmentUid}/forward/{forwardUid} to attach forward rule to apartment

application/json

Request Body

• 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 int32

  Possible values: >= 1 and <= 9999

  Building number

  unit int32

  Possible values: <= 99

  Unit number

  floor int32

  Possible values: <= 98

  Floor number

  room int32

  Possible 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

  The number living in the apartment

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  Possible values: >= -1

  UID for entities referenses. 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

oneOf
• MOD1
• MOD2
---
error string
error string

{
  "error": "Wrong Logical Address"
}

Unauthorized

application/json

• Schema
• Example (from schema)

---

Schema

• error string

{
  "error": "Log In"
}

Loading...