Update Document

Endpoint Name : update_document

Request type : POST

Authorization : Bearer token as header

Endpoint Details : The update_documentendpoint will be used to update the document.

Method	URL
POST	URL/access/klearstack/update_document

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in.
collection_name	string	Yes	Name of collection of document.
id	string	Yes	ID of document.
data	string(JSON)	Yes	A valid JSON string containing details of updates to be done to fields of Document. If coordinates are not available then array will [0,0,0,0] Example : { "doc_date_value": { "_value": "02-Oct-2022", "_coordinates": [1306,87,1444,107], }, "doc_number_value": { "_value": "287269549621X10102022", "_coordinates": [1306,87,1444,107], }, }

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/update_document" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "collection_name=Replace_Collection_Name_Here" \
  --form "id=Replace_Document_ID_Here" \
  --form 'data={
    "doc_date_value": {
        "_value": "02-Oct-2022",
        "_coordinates": [1306, 87, 1444, 107]
    },
    "doc_number_value": {
        "_value": "287269549621X10102022",
        "_coordinates": [1306, 87, 1444, 107]
    }
}'

Python

• Request Body

import requests

url = "URL/access/klearstack/getdocument"

payload = {'company_name': 'Replace_Company_Name_Here',
'collection_name': 'Replace_Collection_Name_Here',
'user_id': 'Replace_User_ID_Here',
'document_id': 'Replace_Document_ID_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("collection_name", "Replace_Your_Collection_Name_Here")
  .addFormDataPart("id", "Replace_Your_Document_ID_Here")
  .addFormDataPart("data", "{\n" +
    "    \"doc_date_value\": {\n" +
    "        \"_value\": \"Replace_Your_Date_Here\",\n" +
    "        \"_coordinates\": [x1, y1, x2, y2]\n" +
    "    },\n" +
    "    \"doc_number_value\": {\n" +
    "        \"_value\": \"Replace_Your_Document_Number_Here\",\n" +
    "        \"_coordinates\": [x1, y1, x2, y2]\n" +
    "    }\n" +
    "}")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/update_document")
  .method("POST", body)
  .addHeader("Authorization", "Bearer Replace_Your_Token_Here")
  .build();
Response response = client.newCall(request).execute();

Node.js

• 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('collection_name', 'Replace_Your_Collection_Name_Here');
formData.append('id', 'Replace_Your_Document_ID_Here');
formData.append('data', '{\r\n    "doc_date_value": {\r\n        "_value": "Replace_Your_Date_Here",\r\n        "_coordinates": [x1, y1, x2, y2]\r\n    },\r\n    "doc_number_value": {\r\n        "_value": "Replace_Your_Document_Number_Here",\r\n        "_coordinates": [x1, y1, x2, y2]\r\n    }\r\n}');

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

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

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("collection_name", "Replace_Your_Collection_Name_Here");
formData.append("id", "Replace_Your_Document_ID_Here");
formData.append("data", "{\r\n    \"doc_date_value\": {\r\n        \"_value\": \"Replace_Your_Date_Here\",\r\n        \"_coordinates\": [x1, y1, x2, y2]\r\n    },\r\n    \"doc_number_value\": {\r\n        \"_value\": \"Replace_Your_Document_Number_Here\",\r\n        \"_coordinates\": [x1, y1, x2, y2]\r\n    }\r\n}");

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/update_document");
xhr.setRequestHeader("Authorization", "Bearer Replace_Your_Token_Here");

xhr.send(formData);

API Response

Status code	Example Response
200	Json Response