Get Access rule Entity

Returns Access rule Entity

Path Parameters

• access-rule-id integer required

  Possible values: >= 1

  Unique Id for access rule

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• 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

{
  "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...