delphiDll / easybill REST API / Fetch PDF Templates list
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
name: PWideChar;
pdf_template: PWideChar;
document_type: PWideChar;
Text_prefix: PWideChar;
Text: PWideChar;
Subject: PWideChar;
Message: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'type','DUNNING,CREDIT');
CkHttp_SetRequestHeader(http,'Authorization','{{apiKey}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.easybill.de/rest/v1/pdf-templates',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "items": [
// {
// "id": "INVOICE-DE",
// "name": "Default template",
// "pdf_template": "DE",
// "document_type": "INVOICE",
// "settings": {
// "text_prefix": "",
// "text": "",
// "email": {
// "subject": "",
// "message": ""
// }
// }
// },
// {
// "id": "INVOICE-DE",
// "name": "Default template",
// "pdf_template": "DE",
// "document_type": "INVOICE",
// "settings": {
// "text_prefix": "",
// "text": "",
// "email": {
// "subject": "",
// "message": ""
// }
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'items');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'items[i].id');
name := CkJsonObject__stringOf(jResp,'items[i].name');
pdf_template := CkJsonObject__stringOf(jResp,'items[i].pdf_template');
document_type := CkJsonObject__stringOf(jResp,'items[i].document_type');
Text_prefix := CkJsonObject__stringOf(jResp,'items[i].settings.text_prefix');
Text := CkJsonObject__stringOf(jResp,'items[i].settings.text');
Subject := CkJsonObject__stringOf(jResp,'items[i].settings.email.subject');
Message := CkJsonObject__stringOf(jResp,'items[i].settings.email.message');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -G -d "type=DUNNING,CREDIT"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/pdf-templates
Postman Collection Item JSON
{
"name": "Fetch PDF Templates list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/pdf-templates?type=DUNNING,CREDIT",
"host": [
"{{baseUrl}}"
],
"path": [
"pdf-templates"
],
"query": [
{
"key": "type",
"value": "DUNNING,CREDIT",
"description": "Filters the templates by the specified type. You can specify several types comma-separated, like type,type,type."
}
]
}
},
"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}}/pdf-templates?type=DUNNING,CREDIT",
"host": [
"{{baseUrl}}"
],
"path": [
"pdf-templates"
],
"query": [
{
"key": "type",
"value": "DUNNING,CREDIT",
"description": "Filters the templates by the specified type. You can specify several types comma-separated, like type,type,type."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"items\": [\n {\n \"id\": \"INVOICE-DE\",\n \"name\": \"Default template\",\n \"pdf_template\": \"DE\",\n \"document_type\": \"INVOICE\",\n \"settings\": {\n \"text_prefix\": \"\",\n \"text\": \"\",\n \"email\": {\n \"subject\": \"\",\n \"message\": \"\"\n }\n }\n },\n {\n \"id\": \"INVOICE-DE\",\n \"name\": \"Default template\",\n \"pdf_template\": \"DE\",\n \"document_type\": \"INVOICE\",\n \"settings\": {\n \"text_prefix\": \"\",\n \"text\": \"\",\n \"email\": {\n \"subject\": \"\",\n \"message\": \"\"\n }\n }\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}}/pdf-templates?type=DUNNING,CREDIT",
"host": [
"{{baseUrl}}"
],
"path": [
"pdf-templates"
],
"query": [
{
"key": "type",
"value": "DUNNING,CREDIT",
"description": "Filters the templates by the specified type. You can specify several types comma-separated, like type,type,type."
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}