DeleteAttachment
DeleteAttachment
This endpoint is used to delete the attachments that were previously uploaded for a particular form.
In your API request, you must include the RecordId of the specific form for which you want to delete attachments.
DELETE Attachment/DeleteAttachment Request Params
| Field | Type | Description |
|---|---|---|
| RecordID | Guid | Unique identifier of the records given by TaxBandits |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
| StatusName | string | Name of the status code |
| StatusMessage | string | Detailed status message |
| RecordId | Guid | Unique identifier of a record |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error code. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request Params
"Attachment/DeleteAttachment?RecordId=01132f6d-ef4a-4014-817e-94a5a19bd52b"
Response JSON
- 200
- 400
- 401
Success Response - You'll get the below response when the request is processed successfully.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"RecordId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"RecordId": null,
"FilePath": null,
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100001",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}