Skip to main content

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 information
  • POST /apartment/item/{apartment-uid}/identifier/{identifier-uid} to attach identifier to apartment
  • POST /apartment/item/{apartment-uid}/photo to add or update apartment's image profile photo
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 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 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 required

    The 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

Responses

OK

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

Loading...