Get the list of attached access rules

Return the list of attached access rules

Path Parameters

• time-profile-id integer required

  Possible values: >= 1

  Unique Id for time profile

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

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• items object[]

  List items

  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

• options object

  Available pagination options

  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

{
  "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
          ]
        }
      ]
    }
  ],
  "options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 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...