DataFlex / easybill REST API / Fetch PDF Templates list
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sName
String sPdf_template
String sDocument_type
String sText_prefix
String sText
String sSubject
String sMessage
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "type" "DUNNING,CREDIT" To iSuccess
Send ComSetRequestHeader To hoHttp "Authorization" "{{apiKey}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.easybill.de/rest/v1/pdf-templates" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "items" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "items[i].id" To sId
Get ComStringOf Of hoJResp "items[i].name" To sName
Get ComStringOf Of hoJResp "items[i].pdf_template" To sPdf_template
Get ComStringOf Of hoJResp "items[i].document_type" To sDocument_type
Get ComStringOf Of hoJResp "items[i].settings.text_prefix" To sText_prefix
Get ComStringOf Of hoJResp "items[i].settings.text" To sText
Get ComStringOf Of hoJResp "items[i].settings.email.subject" To sSubject
Get ComStringOf Of hoJResp "items[i].settings.email.message" To sMessage
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
