Contents x
    Deletes a reader from the project
    • 26 Sep 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Deletes a reader from the project

    • Updated on 26 Sep 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Delete
    /v2/Readers/{readerId}
    Security
    API Key
    Header parameter nameapi_token
    Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
    Path parameters
    readerId
    stringRequired

    The ID of the reader to be deleted

    Responses
    200

    Success

    Readers - Success Response for delete reader

    This is an example for 200 status, success response.

    {
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": null,
  "information": null
}
    Expand All
    object
    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Readers - Invalid reader ID

    Kindly verify your readers Id and perform the operation again. This seems to be an error while finding the reader, find your reader Id from /v2/Readers.

    {
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader id is invalid.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
    Expand All
    object
    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api resonse

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next