Update multiple Access rule items by link_id

Create or Update multiple Access rule items.

This request is used by Link management system. Link adds to each Access rule link_id.

They can be added to multiple devices and removed by link_id param using DELETE /access/access-rules/link

application/json

Request Body required

• items object[] required

  Access rules list

  link_id uuid required

  Possible values: <= 36 characters

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

  name string required

  Possible values: <= 100 characters

  Name of access rule entity

  description string required

  Possible values: <= 255 characters

  Description of access rule entity

  settings object[] required

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

  reader string required

  Unique reader identifier

  relays integer[] required

  Set of relays

  time_profiles object

  List of link_id identifiers

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• result object[]

  List of result describe entities update/delete

  link_id uuid

  Possible values: <= 36 characters

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

  success boolean

  Determines if entity was update successfully

  extended_info string

  Possible values: [created, updated, deleted, entity_not_found, has_duplicates, number_taken_by_another_identifier, bad_base_64_image_file, face_has_not_recognized, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded, invalid_time_rules_settings, number_of_entities_exceeded]

  Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

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