Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"{{secretId}}");
http.put_Password(L"{{secretPassword}}");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://domain.com/api/invoices/:id/",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "description": "<string>",
// "product_identification": "<string>",
// "quantity": "<integer>",
// "unit_code": "<string>",
// "unit_description": "<string>",
// "unit_amount": "<number>",
// "pre_tax_amount": "<number>",
// "tax_percentage": "<number>",
// "tax_amount": "<number>",
// "total_amount": "<number>",
// "retained_taxes": [
// {
// "collected_at": "<dateTime>",
// "tax": "<string>",
// "tax_percentage": "<number>",
// "retained_tax_amount": "<number>"
// },
// {
// "collected_at": "<dateTime>",
// "tax": "<string>",
// "tax_percentage": "<number>",
// "retained_tax_amount": "<number>"
// }
// ],
// "collected_at": "<dateTime>"
// }
// 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 wchar_t *tax = 0;
const wchar_t *retained_tax_amount = 0;
const wchar_t *description = jResp.stringOf(L"description");
const wchar_t *product_identification = jResp.stringOf(L"product_identification");
const wchar_t *quantity = jResp.stringOf(L"quantity");
const wchar_t *unit_code = jResp.stringOf(L"unit_code");
const wchar_t *unit_description = jResp.stringOf(L"unit_description");
const wchar_t *unit_amount = jResp.stringOf(L"unit_amount");
const wchar_t *pre_tax_amount = jResp.stringOf(L"pre_tax_amount");
const wchar_t *tax_percentage = jResp.stringOf(L"tax_percentage");
const wchar_t *tax_amount = jResp.stringOf(L"tax_amount");
const wchar_t *total_amount = jResp.stringOf(L"total_amount");
const wchar_t *collected_at = jResp.stringOf(L"collected_at");
int i = 0;
int count_i = jResp.SizeOfArray(L"retained_taxes");
while (i < count_i) {
jResp.put_I(i);
collected_at = jResp.stringOf(L"retained_taxes[i].collected_at");
tax = jResp.stringOf(L"retained_taxes[i].tax");
tax_percentage = jResp.stringOf(L"retained_taxes[i].tax_percentage");
retained_tax_amount = jResp.stringOf(L"retained_taxes[i].retained_tax_amount");
i = i + 1;
}
}
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/invoices/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/invoices/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `invoice.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific invoice."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"description\": \"<string>\",\n\t\"product_identification\": \"<string>\",\n\t\"quantity\": \"<integer>\",\n\t\"unit_code\": \"<string>\",\n\t\"unit_description\": \"<string>\",\n\t\"unit_amount\": \"<number>\",\n\t\"pre_tax_amount\": \"<number>\",\n\t\"tax_percentage\": \"<number>\",\n\t\"tax_amount\": \"<number>\",\n\t\"total_amount\": \"<number>\",\n\t\"retained_taxes\": [\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t},\n\t\t{\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"tax\": \"<string>\",\n\t\t\t\"tax_percentage\": \"<number>\",\n\t\t\t\"retained_tax_amount\": \"<number>\"\n\t\t}\n\t],\n\t\"collected_at\": \"<dateTime>\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/invoices/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"invoices",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}