Skip to main content

Get Identifier Entity​

Returns detailed info about Identifier

Path Parameters
  • identifierUid integer required

    Possible values: >= 1

    Unique Id for physical/input code identifier

Responses

OK

Schema
  • identifier_owner object
  • name string
  • type string

    Possible values: [owner, guest]

  • identifier_type string

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

  • identifier_number string

    • 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: [second, all, first]

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

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

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

  • count integer

    The number of values in the array

  • additional object
  • passes_left integer

    Possible values: >= -1

    if access is permanent - return -1 value

Loading...