Identifier's list

Return Identifier's list

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

Responses

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• list_items object[]
• 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 tables that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  filter object

  Available filter sets for different tables, one set for one type of tables

  oneOf

  • MOD1
  • MOD2
  • MOD3

  ---

  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

  Baker Street

  filter_field string

  Possible values: [apartment_address]

  Field available for filtering

  filter_type string

  Possible values: [equal]

  Available filter type, only equal here

  filter_format string

  Possible values: [string]

  Available filter format, only string here

  filter_value string

  1-1-0-4

  filter_field string

  Possible values: [residents]

  Field available for filtering

  filter_type string

  Possible values: [less, equal, more]

  Available filter type

  filter_format string

  Possible values: [integer]

  Available filter format, only integer here

  filter_value integer

  Returns apartments with residents count greater then six

  sort object

  Available sorting options for the selected table

  field string

  Sorting field name

  asc boolean

  Direction of sorting

  available_fields string[]

  Available for sorting fields names

{
  "list_items": [
    {
      "identifier_id": 1,
      "identifier_owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "identifier_type": "ukey",
      "identifier_number": "123456ABCD",
      "lock": "first",
      "time": {
        "is_permanent": false,
        "from": 1540819272,
        "to": 1540819272
      },
      "passes": {
        "is_permanent": false,
        "max_passes": 3
      },
      "apartment": 3,
      "time_profiles": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    },
    {
      "identifier_id": 2,
      "identifier_owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "identifier_type": "ukey",
      "identifier_number": "123456ABCD",
      "lock": "first",
      "time": {
        "is_permanent": false,
        "from": 1540819272,
        "to": 1540819272
      },
      "passes": {
        "is_permanent": false,
        "max_passes": 3
      },
      "apartment": 3,
      "time_profiles": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    },
    {
      "identifier_id": 3,
      "identifier_owner": {
        "name": "Sherlock Holmes",
        "type": "owner"
      },
      "identifier_type": "ukey",
      "identifier_number": "123456ABCD",
      "lock": "first",
      "time": {
        "is_permanent": false,
        "from": 1540819272,
        "to": 1540819272
      },
      "passes": {
        "is_permanent": false,
        "max_passes": 3
      },
      "apartment": 3,
      "time_profiles": {
        "count": 4,
        "uid_items": [
          11,
          13,
          23,
          42
        ]
      }
    }
  ],
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "apartment_name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Baker Street"
    },
    "sort": {
      "field": "apartment_name",
      "asc": true,
      "available_fields": [
        "apartment_name"
      ]
    }
  }
}

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

Log In

Administrator rights required

Loading...