Get users list

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

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

• 200
• 400
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_option object

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

  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

  filter object

  Available filter sets for user

  anyOf

  • MOD1
  • MOD2

  ---

  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

  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 users table

  field string

  Sorting field name

  asc boolean

  Sort direction

  available_fields string[]

  Available for sorting fields names

• list_items object[]

  User data

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Sherlock Holmes"
    },
    "sort": {
      "field": "name",
      "asc": true,
      "available_fields": [
        "John"
      ]
    }
  },
  "list_items": [
    {
      "identifiers": {
        "uid_items": [
          3
        ]
      },
      "apartments": {
        "uid_items": [
          3
        ]
      },
      "timeprofiles": {
        "uid_items": [
          3
        ]
      },
      "name": "John Doe",
      "item_uid": 0,
      "lock_number": 1,
      "is_custom_user_access": false,
      "auth_factors": [
        "card",
        "card",
        "card",
        "card"
      ],
      "info": "Employee"
    }
  ]
}

{
  "list_options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "name",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "Sherlock Holmes",
      "available_filtering": true,
      "available_fields": [
        "name",
        "info"
      ],
      "is_filtered": true
    },
    "sort": {
      "field": "name",
      "asc": true,
      "available_fields": [
        "name"
      ]
    }
  },
  "list_items": [
    {
      "item_uid": 0,
      "name": "John Doe",
      "auth_factors": [
        "face_id",
        "card"
      ],
      "lock_number": 1,
      "is_custom_user_access": false,
      "info": "Employee",
      "apartments": {
        "uid_items": [
          1,
          2,
          3
        ]
      },
      "identifiers": {
        "uid_items": [
          2,
          3,
          4
        ]
      },
      "timeprofiles": {
        "uid_items": [
          2,
          3,
          4
        ]
      }
    }
  ]
}

Base errors for all entities

• Wrong pagination limit
• Wrong page number
• Wrong filter type
• Wrong filter field
• Wrong filter format
• Wrong filter value
• Wrong sort type
  Errors appeared only in log entities:
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
  Errors appeared in other entities:
• Wrong sort field

application/json

• Schema
• Example (from schema)
• Pagination Limit
• Pagination Page Number
• Sort type
• Sort field
• Filter type
• Filter field
• Filter value
• Filter format
• Time format
• Time range

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...