# 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 `getdocumentsetstatus`endpoint 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.

<table data-header-hidden><thead><tr><th width="124"></th><th></th></tr></thead><tbody><tr><td>Method</td><td>URL</td></tr><tr><td>POST</td><td><code>URL/access/klearstack/getdocumentsetstatus</code></td></tr></tbody></table>

### Request Body

<table data-header-hidden><thead><tr><th width="223"></th><th width="97"></th><th width="93.63641357421875"></th><th></th></tr></thead><tbody><tr><td>Params</td><td>Values</td><td>Required</td><td>Description</td></tr><tr><td>company_name</td><td>string</td><td>Yes</td><td>Name of the company for which the user is logging in</td></tr><tr><td>username</td><td>string</td><td>Yes</td><td>User Name</td></tr><tr><td>set_reference_number</td><td>string </td><td>No</td><td>Set Reference Number of the Document Set.</td></tr><tr><td>status (Optional)</td><td>string</td><td>No</td><td>Accepts either of two values, "In Progress" or "Completed" to filter results based on status.</td></tr></tbody></table>

### Shell (cURL)

* Request Body

```sh
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

```python
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

```java
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

```javascript
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

```javascript
// 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

<table data-header-hidden><thead><tr><th width="146"></th><th></th></tr></thead><tbody><tr><td>Status code</td><td>Example Response</td></tr><tr><td>200</td><td><p></p><pre class="language-json"><code class="lang-json">{
    "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
}
</code></pre></td></tr></tbody></table>