Get Access rules list

Returns Access rules list

Query Parameters

• limit integer required

  Possible values: <= 1000

  Number of items. Value by default is 10

• page_number integer required

  Possible values: >= 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)

---

Schema

• options object

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

  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: <= 1000

  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

  Specified filtering options for the requested dataset

  available_filtering boolean

  Determines if filtering is available for this dataset

  is_filtered boolean

  Describes if this dataset is filtered

  available_fields object[]

  List of fields available for filtering

  field_name string

  Name of the field used for filtering

  compare_operators string[]

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

  Set of filter operators available for this field

  data_type string

  Possible values: [string, integer, timestamp]

  Describes data type of the field

  options object

  Extra settings of the field

  anyOf

  • MOD1
  • MOD2
  • MOD3
  • MOD4

  ---

  available_values object[]

  This model provide filter available values, data type of values depends on field data type

  available_values object[]

  This model provide filter available values, data type of values depends on field data type

  available_values_localized string[]

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

  available_range object

  This model provide filter integer range

  min integer

  Represents minimum range value

  max integer

  Represents maximum range value

  has_date boolean

  Default value: false

  Determines if field value has date part, used for timestamp data type

  has_time boolean

  Default value: false

  Determines if field value has time part, used for timestamp data type

  has_milliseconds boolean

  Default value: false

  Determines if field value has milliseconds part, used for timestamp data type

  sort object

  Describes current sorting information and list of the dataset fields available for sorting

  is_sorted boolean

  Direction of sorting

  order string

  Possible values: [asc, desc]

  Direction of applied sorting, true is ascending, false is descending

  available_fields string[]

  List of the dataset fields available for sorting

• items object[]

  List of Access rules

  id integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

  link_id object

  Unique entity set by the server to bind some parameters with each other

  name string

  Possible values: <= 100 characters

  Name of access rule entity

  description string

  Possible values: <= 255 characters

  Description of access rule entity

  settings object[]

  Describes relations the reader-to-relay relationship for the access rule entity

  reader string

  Unique reader identifier

  relays integer[]

  Set of relays

  references_count object

  list of the number of links

  identifiers integer

  Count of identifiers attached to the access rules

  time_profiles integer

  Count of time_profiles attached to the access rules

  users integer

  Count of users attached to the access rules

{
  "options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "field_name": "category",
          "compare_operators": [
            "eq"
          ],
          "data_type": "string",
          "options": {
            "available_values": [
              "extra option",
              1,
              false
            ]
          }
        }
      ]
    },
    "sort": {
      "is_sorted": true,
      "order": "asc",
      "available_fields": [
        "name"
      ]
    }
  },
  "items": [
    {
      "id": 3,
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "name": "Main access rule",
      "description": "Main access used as general access rule for whole building",
      "settings": [
        {
          "reader": "wiegand_1",
          "relays": [
            1
          ]
        }
      ],
      "references_count": {
        "identifiers": 1,
        "time_profiles": 1,
        "users": 1
      }
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

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

  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

  Contains validation error details

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

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

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

  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

  Contains validation error details

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

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...