Get Uploaded Status of Documents in a Document Set

Endpoint Name: URL/access/klearstack/getdocumentsetstatus

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The getdocumentsetstatusendpoint will be used to retrieve the upload status of documents in a document set. It will provide details on whether each document is in progress or completed.

Method	URL
POST	URL/access/klearstack/getdocumentsetstatus

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
username	string	Yes	User Name
set_reference_number	string	No	Set Reference Number of the Document Set.
status (Optional)	string	No	Accepts either of two values, "In Progress" or "Completed" to filter results based on status.

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/getdocumentsetstatus" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "username=Replace_Username_Here" \
  --form "set_reference_number=Replace_Set_Reference_Number_Here" \
  --form "status=Replace_Status_Here"

Python

• Request Body

import requests

url = "URL/access/klearstack/getdocumentsetstatus"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_Username_Here',
'set_reference_number': 'Replace_Set_Reference_Number_Here',
'status': 'Replace_Status_Here'}
files=[

]
headers = {
  'Authorization': 'Bearer your_token_here'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("company_name", "Replace_Your_Company_Name_Here")
  .addFormDataPart("username", "Replace_Your_Username_Here")
  .addFormDataPart("set_reference_number", "Replace_Your_Set_Reference_Number_Here")
  .addFormDataPart("status", "Replace_Your_Status_Here")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/getdocumentsetstatus")
  .method("POST", body)
  .addHeader("Authorization", "Bearer Replace_Your_Token_Here")
  .build();
Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');

let formData = new FormData();
formData.append('company_name', 'Replace_Your_Company_Name_Here');
formData.append('username', 'Replace_Your_Username_Here');
formData.append('set_reference_number', 'Replace_Your_Set_Reference_Number_Here');
formData.append('status', 'Replace_Your_Status_Here');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/getdocumentsetstatus',
  headers: { 
    'Authorization': 'Bearer Replace_Your_Token_Here', 
    ...formData.getHeaders()
  },
  data: formData
};

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

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.

var formData = new FormData();
formData.append("company_name", "Replace_Your_Company_Name_Here");
formData.append("username", "Replace_Your_Username_Here");
formData.append("set_reference_number", "Replace_Your_Set_Reference_Number_Here");
formData.append("status", "Replace_Your_Status_Here");

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/access/klearstack/getdocumentsetstatus");
xhr.setRequestHeader("Authorization", "Bearer Replace_Your_Token_Here");

xhr.send(formData);

API Response

Status code	Example Response
200	{ "set_reference_number": "1722327914109385", "set_name": "BB_Set5", "doc_details_list": [ { "set_reference_number": "1722327914109385", "collection_name": "Invoices", "file_name": "test.pdf", "status": "Completed" } ], "set_created_by": "Admin", "creation_date": "2024-07-30T13:55:14.823", "Set_Documents_Count": 1 }