Skip to main content

Get User Entity​

Returns detailed info about User

Path Parameters
  • userUid integer required

    Possible values: >= 1

    Unique Identifier for User Item

Responses

OK

Schema
  • auth_factors string[]

    Possible values: [face_id, card, input_code, qr, license_plate]

  • item_uid integer
  • link_id uuid

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

  • name string
  • lock_number integer
  • is_custom_user_access boolean
  • info string
  • identifiers object[]
  • identifier_uid integer

    Possible values: >= -1

    UID for entities referenses. If value is -1, then it means that is no entity reference for this structure

  • identifier_owner object
  • name string
  • type string

    Possible values: [owner, guest]

  • identifier_type string

    Possible values: [card, ukey, inputCode, face_id, qr, license_plate]

  • identifier_number string

    • hex, number or face eiginvalue data in Base64 - This param ignored if you create face identifier by uploading image

    • hex or dec if identifier_type is card or ukey

    • dec if identifier_type is inputCode

    • uuid if identifier_type is qr

    • pattern for hex and dec - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})

  • lock string

    Possible values: [first, second, all]

  • valid object
  • time object
  • is_permanent boolean
  • from int64

    Unix Timestamp Date

  • to int64

    Unix Timestamp Date

  • passes object
  • is_permanent boolean
  • max_passes integer

    Possible values: >= 1

  • apartment object
  • uid integer

    Possible values: >= -1

    UID for entities referenses. If value is -1, then it means that is no entity reference for this structure

  • link_id uuid

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

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

  • time_profiles object

    Model used to providing array of UIDs of various enumerated entities stored in the panel, such as apartments, identifiers, forward, and similar

  • uid_items integer[]

    Possible values: >= -1

    Array of UID for entities referenses.

  • link_ids uuid[]

    Array of LinkIDs for entities references

  • count integer

    The number of values in the array

  • additional object
  • passes_left integer

    Possible values: >= -1

    if access is permanent - return -1 value

  • apartments object[]
  • 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

    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

    Optional information about tenants

  • count integer

    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

  • item_uid integer
  • timeprofiles object[]
  • name string
  • time_options object
  • is_all_day boolean
  • date_from int64

    Unix Timestamp Date

  • date_to int64

    Unix Timestamp Date

  • repeat_options object

    The model describes repeat option for time range in Timeprofile

  • repeat_enable boolean
  • repeat_format object

    The model describes repeat format in Timeprofile

  • repeat_type string

    Possible values: [day, week, twoWeeks, month, year, custom]

  • repeat_end object

    date key required if date format was chosen

  • format string

    Possible values: [never, date]

  • date int64

    Unix Timestamp Date

  • repeat_custom object

    Only for custom repeat type

  • repeat_point_type string

    Possible values: [day, week, month, year]

  • repeat_looper integer

    Possible values: >= 1 and <= 1000

  • repeat_options object
    oneOf
  • string

    Possible values: [MON, TUE, WED, THU, FRI, SAT, SUN]

Loading...