C++ / easybill REST API / Fetch a list of stock entries for positions
Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
CkJsonObject queryParams;
queryParams.UpdateString("limit","<integer>");
queryParams.UpdateString("page","<integer>");
queryParams.UpdateString("position_id","<string>");
queryParams.UpdateString("document_id","<string>");
http.SetRequestHeader("Authorization","{{apiKey}}");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/stocks",queryParams);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "stock_count": "<long>",
// "position_id": "<long>",
// "id": "<long>",
// "note": "<string>",
// "document_id": "<long>",
// "document_position_id": "<long>",
// "stored_at": "<string>",
// "created_at": "<string>",
// "updated_at": "<string>"
// },
// {
// "stock_count": "<long>",
// "position_id": "<long>",
// "id": "<long>",
// "note": "<string>",
// "document_id": "<long>",
// "document_position_id": "<long>",
// "stored_at": "<string>",
// "created_at": "<string>",
// "updated_at": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const char *stock_count = 0;
const char *position_id = 0;
const char *id = 0;
const char *note = 0;
const char *document_id = 0;
const char *document_position_id = 0;
const char *stored_at = 0;
const char *created_at = 0;
const char *updated_at = 0;
const char *page = jResp.stringOf("page");
const char *pages = jResp.stringOf("pages");
const char *limit = jResp.stringOf("limit");
const char *total = jResp.stringOf("total");
int i = 0;
int count_i = jResp.SizeOfArray("items");
while (i < count_i) {
jResp.put_I(i);
stock_count = jResp.stringOf("items[i].stock_count");
position_id = jResp.stringOf("items[i].position_id");
id = jResp.stringOf("items[i].id");
note = jResp.stringOf("items[i].note");
document_id = jResp.stringOf("items[i].document_id");
document_position_id = jResp.stringOf("items[i].document_position_id");
stored_at = jResp.stringOf("items[i].stored_at");
created_at = jResp.stringOf("items[i].created_at");
updated_at = jResp.stringOf("items[i].updated_at");
i = i + 1;
}
}
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-d "position_id=%3Cstring%3E"
-d "document_id=%3Cstring%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/stocks
Postman Collection Item JSON
{
"name": "Fetch a list of stock entries for positions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"stocks"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter stock entries by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter stock entries by document id."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"stocks"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter stock entries by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter stock entries by document id."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"stock_count\": \"<long>\",\n \"position_id\": \"<long>\",\n \"id\": \"<long>\",\n \"note\": \"<string>\",\n \"document_id\": \"<long>\",\n \"document_position_id\": \"<long>\",\n \"stored_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n },\n {\n \"stock_count\": \"<long>\",\n \"position_id\": \"<long>\",\n \"id\": \"<long>\",\n \"note\": \"<string>\",\n \"document_id\": \"<long>\",\n \"document_position_id\": \"<long>\",\n \"stored_at\": \"<string>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/stocks?limit=<integer>&page=<integer>&position_id=<string>&document_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"stocks"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
},
{
"key": "position_id",
"value": "<string>",
"description": "Filter stock entries by position id."
},
{
"key": "document_id",
"value": "<string>",
"description": "Filter stock entries by document id."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
