Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *document_id;
const wchar_t *v_to;
const wchar_t *cc;
const wchar_t *from;
const wchar_t *subject;
const wchar_t *message;
const wchar_t *date;
const wchar_t *created_at;
const wchar_t *processed_at;
const wchar_t *send_by_self;
const wchar_t *send_with_attachment;
const wchar_t *v_type;
const wchar_t *status;
const wchar_t *status_msg;
const wchar_t *login_id;
const wchar_t *document_file_type;
const wchar_t *post_send_type;
const wchar_t *tracking_identifier;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_SetRequestHeader(http,L"Authorization",L"{{apiKey}}");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://api.easybill.de/rest/v1/post-boxes/:id",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<long>",
// "document_id": "<long>",
// "to": "<string>",
// "cc": "<string>",
// "from": "<string>",
// "subject": "<string>",
// "message": "<string>",
// "date": "<date>",
// "created_at": "<dateTime>",
// "processed_at": "<dateTime>",
// "send_by_self": "<boolean>",
// "send_with_attachment": "<boolean>",
// "type": "EMAIL",
// "status": "PROCESSING",
// "status_msg": "<string>",
// "login_id": "<long>",
// "document_file_type": "default",
// "post_send_type": "post_send_type_registered",
// "tracking_identifier": "<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.
id = CkJsonObjectW_stringOf(jResp,L"id");
document_id = CkJsonObjectW_stringOf(jResp,L"document_id");
v_to = CkJsonObjectW_stringOf(jResp,L"to");
cc = CkJsonObjectW_stringOf(jResp,L"cc");
from = CkJsonObjectW_stringOf(jResp,L"from");
subject = CkJsonObjectW_stringOf(jResp,L"subject");
message = CkJsonObjectW_stringOf(jResp,L"message");
date = CkJsonObjectW_stringOf(jResp,L"date");
created_at = CkJsonObjectW_stringOf(jResp,L"created_at");
processed_at = CkJsonObjectW_stringOf(jResp,L"processed_at");
send_by_self = CkJsonObjectW_stringOf(jResp,L"send_by_self");
send_with_attachment = CkJsonObjectW_stringOf(jResp,L"send_with_attachment");
v_type = CkJsonObjectW_stringOf(jResp,L"type");
status = CkJsonObjectW_stringOf(jResp,L"status");
status_msg = CkJsonObjectW_stringOf(jResp,L"status_msg");
login_id = CkJsonObjectW_stringOf(jResp,L"login_id");
document_file_type = CkJsonObjectW_stringOf(jResp,L"document_file_type");
post_send_type = CkJsonObjectW_stringOf(jResp,L"post_send_type");
tracking_identifier = CkJsonObjectW_stringOf(jResp,L"tracking_identifier");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes/:id
Postman Collection Item JSON
{
"name": "Fetch post box",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of post box"
}
]
}
},
"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}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"<long>\",\n \"document_id\": \"<long>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"date\": \"<date>\",\n \"created_at\": \"<dateTime>\",\n \"processed_at\": \"<dateTime>\",\n \"send_by_self\": \"<boolean>\",\n \"send_with_attachment\": \"<boolean>\",\n \"type\": \"EMAIL\",\n \"status\": \"PROCESSING\",\n \"status_msg\": \"<string>\",\n \"login_id\": \"<long>\",\n \"document_file_type\": \"default\",\n \"post_send_type\": \"post_send_type_registered\",\n \"tracking_identifier\": \"<string>\"\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"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}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}