Delete identifiers (single or list)

Identifier delete request

Batch mode:

• request body must contain list_items
• identifier_number is required for each item

Single mode:

• request body is not required
• identifier is identified using query parameters:
  • type
  • number

Query Parameters

• type string required

  Possible values: [card, face_id, inputCode, qr, ukey, license_plate]

  Identifier type

• number object

  Required only for single identifier operations and optional for batch operations

application/json

Request Body

List of identifiers to delete in batch mode.

• list_items object[] required

  Possible values: >= 1

  List of identifiers to be deleted in batch mode

  identifier_number object required

  Identifier number in HEX or Decimal format depending on the selected Wiegand Identifier representation mode.

  Warning: The same value may represent different identifiers in different modes. For example, 44 is identifier 44 in Decimal mode, but identifier 68 in Decimal representation when HEX mode is used (0x44).

  Ensure the correct representation mode is selected before performing update or delete operations.

  oneOf

  • MOD1
  • MOD2

  ---

  string

  integer

Responses

• 200
• 400
• 401
• 403

---

Per-identifier delete operation result. Both single and batch delete modes return the same response structure.

application/json

• Schema
• Example (from schema)

---

Schema

• result object[]

  Delete operation results per identifier

{
  "result": [
    {
      "identifier_type": "card",
      "success": true,
      "identifier_number": "string",
      "extended_info": "updated"
    }
  ]
}

Request is invalid or cannot be parsed. No data processing was performed.

Possible reasons:

• Missing or invalid identifier type
• Invalid identifier number format
• Missed json body or wrong param Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Empty list
• Wrong or missed param

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "List cannot be empty"
}

{
  "error": "Wrong or missing parameters"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...