Skip to main content

Get Identifier Entity​

Returns detailed info about Identifier

Path Parameters
  • identifier-uid integer required

    Possible values: >= 1

    Unique Id for physical/input code identifier

Responses

OK

Schema
  • identifier_owner object

    Identifier owner information

  • name string

    User name

  • type string

    Possible values: [owner, guest]

    Identifier owner type

  • identifier_type string

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

    Identifier type

  • identifier_number string

    • hex, number or face eigenvalue 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]

    Lock

  • valid object

    Access restriction by time and passes

  • time object

    Restriction by time

  • is_permanent boolean

    If enabled Identifier will has permanent access by time

  • from int64

    Unix Timestamp Date

  • to int64

    Unix Timestamp Date

  • passes object

    Restriction by passes

  • is_permanent boolean

    If enabled Identifier will has permanent access by passes

  • max_passes integer

    Possible values: >= 1

    Max passes count. If Identifier is permanent this field is not required

  • apartment object

    Apartment info

  • uid integer

    Possible values: >= -1

    UID for entities references. 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 are stored in the panel, such as apartments, identifiers, forward, and similar with count param

  • uid_items integer[]

    Possible values: >= -1

    Array of UID for entities references

  • link_ids uuid[]

    Array of LinkIDs for entities references

  • count integer

    The number of values in the array

  • additional object

    This model describes information about number of remaining passes for the identifier

  • passes_left integer

    Possible values: >= -1

    Remaining passes. If access is permanent - return -1 value

Loading...