Skip to main content

Get multiple Identifier items with link_id.

This can be used by 3d-party management system. Link adds to each identifier and apartment link_id and apartment_link_id to link them together.

Query Parameters
  • limit integer

    Possible values: [10, 20, 30, 50]

    Number of items. Value by default is 10

  • page_number integer

    Possible values: >= 1

    Page number

  • sort_field string

    Field name (JSON Key in item entity)

  • sort_type string

    Possible values: [asc, desc]

    Default value: asc

    Sort type (asc/desc)

  • filter object

    Filtering options for Identifiers

Responses

OK

Schema
  • list_items object[]

    Identifier with link ID

  • 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

  • face_image string

    Optional field which allow to add face images in base64 format via link_id, if face_image field is defined, identifier_number ignored, and generates automatically

  • time_profiles object

    List of unique entity ids of apartments, identifiers, timeprofiles, forwards. Typically used for bulk delete operations

  • link_ids uuid[]

    List of Link IDs

  • link_id uuid

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

  • apartment_link_id uuid

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

  • additional object

    Passes left

  • passes_left int32

    Passes left

  • list_option object

    This model provides the options can be used to sort, filter and pagination when getting list of identifiers

  • pagination object

    Available pagination options for tables

  • total_items integer

    The total number of items found and reflected across all pages

  • items_limit integer

    Possible values: [10, 20, 30, 50]

    Limiting the display of the amount of data for one page

  • total_pages integer

    The number of pages that hold the requested data

  • current_page integer

    Possible values: >= 1

    Current page number

  • filter object

    Available set of filters for the identifier table

    anyOf
  • filter_field string

    Field available for filtering

  • filter_type string

    Possible values: [equal]

    Available filtering type, only equal here

  • filter_format string

    Data format, only string here

  • filter_value string

    Identifier name

  • sort object

    Available sorting options for the identifiers table

  • field string

    Sorting field name

  • asc boolean

    Sort direction

  • available_fields string[]

    Available for sorting fields names

Loading...