Create Apartment Entity

Creates Apartment Entity

application/json

Request Body required

• apartment_address object

  building int32

  Possible values: >= 1 and <= 999

  Building number

  unit int32

  Possible values: >= 1 and <= 99

  Unit number

  floor int32

  Possible values: >= 1 and <= 99

  Floor number

  room int32

  Possible values: >= 1 and <= 99

  Room number

• apartment_name string
• residents object

  count integer

Responses

• 200
• 400
• 401

---

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

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
• Apartment with that Logical Address already exist

Log In

Loading...