Create Apartment Entity

Create Apartment Entity

application/json

Request Body required

• apartment_address object

  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 integer

  Possible values: >= 1 and <= 9999

  Building number

  unit integer

  Possible values: <= 99

  Unit number

  floor integer

  Possible values: <= 98

  Floor number

  room integer

  Possible values: <= 99

  Room number

• apartment_name string

  Name for the apartment, owner full name or apartment number usually used

• residents object

  Optional information about tenants

  count integer

  The number living in the apartment

• link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

Responses

• 200
• 400
• 401
• 403

---

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
}

• Wrong JSON body
• Wrong Logical Address
• Apartment with that Logical Address already exist

Log In

Administrator rights required

Loading...