Get identifiers list

Returns identifiers list with options could be used to sort and filter them

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

• sort_field string

  field name see the list of available fields in sort.available_fields[]

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/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

  field string

  asc boolean

  available_fields string[]

  Possible values: [identifier_number, name]

  filter object

  available_filtering boolean

  is_filtered boolean

  available_fields object[]

  field_name string

  compare_operators string[]

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

  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

  data_type string

  Possible values: [string, integer, timestamp]

  options object

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values string,integer[]

  Possible values: >= 1

  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

  has_time boolean

  Default value: false

  has_milliseconds boolean

  Default value: false

• list_items object[]

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "name",
      "asc": true,
      "available_fields": [
        "name"
      ]
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "category",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "any string"
            ]
          }
        }
      ]
    }
  },
  "list_items": [
    {
      "identifier_uid": 3,
      "identifier_owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "identifier_type": "ukey",
      "identifier_number": "12345678",
      "lock": "first",
      "valid": {
        "time": {
          "is_permanent": true,
          "from": 1540819272,
          "to": 1540819272
        },
        "passes": {
          "is_permanent": true,
          "max_passes": 0
        }
      },
      "apartment": {
        "uid": 3,
        "logical_address": {
          "building": 1,
          "unit": 1,
          "floor": 1,
          "room": 1
        }
      },
      "time_profiles": {
        "uid_items": [
          11,
          13,
          23,
          42
        ],
        "count": 4
      },
      "additional": {
        "passes_left": 3
      }
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "sort": {
      "field": "name",
      "asc": true,
      "available_fields": [
        "name"
      ]
    },
    "filter": {
      "is_filtered": false,
      "available_filtering": true,
      "available_fields": [
        {
          "field_name": "identifier_number",
          "compare_operators": [
            "eq",
            "nq"
          ],
          "data_type": "string",
          "options": {}
        },
        {
          "field_name": "identifier_type",
          "compare_operators": [
            "eq",
            "nq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "card",
              "ukey",
              "inputCode",
              "qr"
            ]
          }
        },
        {
          "field_name": "owner_name",
          "compare_operators": [
            "eq",
            "nq"
          ],
          "data_type": "string",
          "options": {}
        },
        {
          "field_name": "owner_type",
          "compare_operators": [
            "eq",
            "nq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "owner",
              "guest"
            ]
          }
        }
      ]
    }
  },
  "list_items": [
    {
      "identifier_uid": 3,
      "identifier_owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "identifier_type": "ukey",
      "identifier_number": "12345678",
      "lock": "first",
      "valid": {
        "time": {
          "is_permanent": true,
          "from": 1540819272,
          "to": 1540819272
        },
        "passes": {
          "is_permanent": true,
          "max_passes": 0
        }
      },
      "apartment": {
        "uid": 3,
        "logical_address": {
          "building": 1,
          "unit": 1,
          "floor": 1,
          "room": 1
        }
      },
      "time_profiles": {
        "uid_items": [
          11,
          13,
          23,
          42
        ],
        "count": 4
      },
      "additional": {
        "passes_left": 3
      }
    }
  ]
}

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

application/json

• Schema
• Example (from schema)
• Wrong pagination limit

---

Schema

• error string

{
  "error": true
}

{
  "error": "Wrong pagination limit"
}

Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...