Get Set Reference Numbers List

Endpoint Name: URL/access/klearstack/getsetreferencenumbers

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The getsetreferencenumbers endpoint will be used to retrieve all available set reference numbers.

Method	URL
POST	URL/access/klearstack/getsetreferencenumbers

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
page_index	string	Yes	get set_reference_number by page sorted by creation date in descending order
limit	string	Yes	number of results in a page

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/getsetreferencenumbers" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "username=Replace_Username_Here" \
  --form "page_index=Replace_Page_Index_Here" \
  --form "limit=Replace_Limit_Here"

Python

• Request Body

import requests

url = "URL/access/klearstack/getsetreferencenumbers"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_Username_Here',
'page_index': 'Replace_Page_Index_Here',
'limit': 'Replace_Limit_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("page_index", "Replace_Your_Page_Index_Here")
  .addFormDataPart("limit", "Replace_Your_Limit_Here")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/getsetreferencenumbers")
  .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('page_index', 'Replace_Your_Page_Index_Here');
formData.append('limit', 'Replace_Your_Limit_Here');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/getsetreferencenumbers',
  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("username", "Replace_Your_Username_Here");
formData.append("page_index", "Replace_Your_Page_Index_Here");
formData.append("limit", "Replace_Your_Limit_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/getsetreferencenumbers");
xhr.setRequestHeader("Authorization", "Bearer Replace_Your_Token_Here");

xhr.send(formData);

API Response

Status code	Example Response
200	{ "set_details": [ { "set_reference_number": "1722327914109385", "set_name": "BB_Set5", "set_created_by": "Admin", "creation_date": "2024-07-30T13:55:14.823" } ], "page_index": "1", "total_pages": "9" }