Delete multiple User Entities with link_id

Delete multiple User Entities with link_id. If user with provided link_id exists - it will be removed. If entity doesn't exist in system - operation will be ignored

application/json

Request Body

• link_ids uuid[] required

  Possible values: <= 36 characters

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