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/delete 

Request Body

Field	Type	Description
RecordIds	Guid[]	Unique identifier of the records given by TaxBandits

Response Body

Field	Type	Description
SuccessRecords	object[]	It will show the detailed status information for the attachments that were successfully deleted from the specified records.
RecordId	Guid	Unique identifier of a record
ErrorRecords	object[]	It will show the detailed status information for the attachments that failed to be deleted from the specified records.
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.
Errors	object[]	Shows detailed error information.
Id	string	Returns the validation error ID.
Name	string	Name of the validation error.
Message	string	Description of the validation error.

Payload

Request Params

Sample	Description	Action
Sample 1	Query Params - Delete the attachments that were previously uploaded

Sample 1

Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b

Response JSON

Response	Description	Action
200	Success Response - You'll get the below response when the request is processed successfully.

Response: 200

{
  "SuccessRecords": [
    {
      "RecordId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1"
    }
  ],
  "ErrorRecords": null,
  "Errors": null
}

Go Lang

  package main

  import (
      "fmt"
      "io"
      "net/http"
  )

  func main() {
      url := "<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b"
      method := "DELETE"

      // DELETE request does not require a request body
      req, err := http.NewRequest(method, url, nil)
      if err != nil {
          fmt.Println(err)
          return
      }

      req.Header.Add("Content-Type", "application/json")
      req.Header.Add("Authorization", "<ACCESS_TOKEN>")

      client := &http.Client{}

      res, err := client.Do(req)
      if err != nil {
          fmt.Println(err)
          return
      }
      defer res.Body.Close()

      body, err := io.ReadAll(res.Body)
      if err != nil {
          fmt.Println(err)
          return
      }

      fmt.Println(string(body))
  }

Node.js

  const axios = require('axios');
  let data = '';

  let config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: '<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b',
  headers: { 
      'Content-Type': 'application/json', 
      'Authorization': '<ACCESS_TOKEN>'
  },
  data : data
  };

  axios.request(config)
  .then((response) => {
  console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
  console.log(error);
  });

Python

  import http.client
  import json

  conn = http.client.HTTPSConnection("<APIURL>")
  payload = ''
  headers = {
  'Content-Type': 'application/json',
  'Authorization': '<ACCESS_TOKEN>'
  }
  conn.request("DELETE", "/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b", payload, headers)
  res = conn.getresponse()
  data = res.read()
  print(data.decode("utf-8"))

.NET C#

  var client = new HttpClient();
  var request = new HttpRequestMessage(HttpMethod.Delete, "<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b");
  request.Headers.Add("Authorization", "<ACCESS_TOKEN>");
  var content = new StringContent("", null, "application/json");
  request.Content = content;
  var response = await client.SendAsync(request);
  response.EnsureSuccessStatusCode();
  Console.WriteLine(await response.Content.ReadAsStringAsync());

Ruby

  require "uri"
  require "json"
  require "net/http"

  url = URI("<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b")

  http = Net::HTTP.new(url.host, url.port);
  request = Net::HTTP::Delete.new(url)
  request["Content-Type"] = "application/json"
  request["Authorization"] = "<ACCESS_TOKEN>"

  response = http.request(request)
  puts response.read_body

Java

  OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
  MediaType mediaType = MediaType.parse("application/json");
  RequestBody body = RequestBody.create(mediaType, "");
  Request request = new Request.Builder()
  .url("<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b")
  .method("DELETE", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "<ACCESS_TOKEN>")
  .build();
  Response response = client.newCall(request).execute();

cURL

  curl --location --request DELETE '<APIURL>/v2.0.0/Attachment/Delete?RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b'   --header 'Content-Type: application/json'   --header 'Authorization: <ACCESS_TOKEN>'   --data ''