Get identifiers list

• Returns identifiers list with options, could be used to sort and filter them
• Available only in access control mode

Query Parameters

• limit integer required

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

  Default value: 10

  Number of items. Value by default is 10

• page_number integer required

  Possible values: >= 1

  Default value: 1

  Page number

• order_by string

  sorting expression:

  [field name 1], [field name 2]... <order (asc or desc)>

• filter string

  Filtering expression:

  [field name] [compare operator] [value] <logical operator>...

  field name	see the list of available fields in filter.available_fields[].field_name
  value	see the list of available values in filter.available_fields[].options object, may be missing
  compare operator	see the list of available operators in filter.available_fields[].compare_operators array

  Compare operators	Description	Example
  eq	Equal	name eq 'Sherlock Holmes'
  gt	Greater than	building gt 10
  lt	Less than	building lt 10
  nq	Not equal	name nq 'Sherlock Holmes'
  ge	Greater than or equal	floor ge 5
  le	Less than or equal	floor le 5
  Logical operators
  and	logical AND	floor le 10 and floor gt 3
  or	logical OR	floor le 3 or floor gt 10
  not	logical NOT	not floor le 3
  group operations
  ()	group by priority	(name eq 'Sherlock Holmes' or building eq 221) and floor gt 10

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_option object

  Available options for sorting, filtering and pagination of lists

  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, 25, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  Possible values: >= 1

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  sort object

  this model describes all available sorting options for identifiers

  is_sorted boolean

  Direction of sorting

  order string

  Possible values: [asc, desc]

  In which order should be sorted, ascending or descending

  available_fields string[]

  Possible values: [name, number]

  Available for sorting fields names

  filter object

  Available fields

  field name	compare operators	type	values
  owner_name	eq, nq	string
  owner_type	eq, nq	string	owner, guest
  number	eq, nq	string
  type	eq, nq	string	card, ukey, input_code, qr, face_id

  available_filtering boolean

  is filtering available

  is_filtered boolean

  is currently filtered

  available_fields object[]

  available fields for filtering

  field_name string

  compare_operators string[]

  Possible values: [eq, gt, lt, nq, ge, le]

  data_type string

  Possible values: [string, integer, timestamp]

  options object

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values object[]

  This model provide filter available values

  available_range integer[]

  Possible values: >= 2, <= 2

  This model provide filter integer range

  available_values_localized string[]

  the field is used only for UI localization and is not a filter value.

  has_date boolean

  Default value: false

  filtering by date

  has_time boolean

  Default value: false

  filtering by time

  has_milliseconds boolean

  Default value: false

  filtering by timestamp

• list_items object[]

  array of identifiers

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "number"
      ]
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "category",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "string",
              0
            ]
          }
        }
      ]
    }
  },
  "list_items": [
    {
      "uid": 3,
      "number": "12345678",
      "type": "card",
      "owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "floors": [
        1
      ],
      "apartments": [
        "01-11"
      ]
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "number"
      ]
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "number",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "any string"
            ]
          }
        }
      ]
    }
  },
  "list_items": [
    {
      "uid": 3,
      "number": "12345678",
      "type": "card",
      "owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "floors": [
        2
      ],
      "apartments": [
        "01-11"
      ]
    }
  ]
}

• Wrong pagination limit
• Wrong pagination page number
• Wrong sort field
• Wrong sort type
• Wrong filter options

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...