Chilkat Online Tools

VB6 / easybill REST API / Fetch PDF Templates list

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("type","DUNNING,CREDIT")

http.SetRequestHeader "Authorization","{{apiKey}}"
http.SetRequestHeader "Accept","application/json"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/pdf-templates",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim id As String
Dim name As String
Dim pdf_template As String
Dim document_type As String
Dim Text_prefix As String
Dim Text As String
Dim Subject As String
Dim Message As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("items")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("items[i].id")
    name = jResp.StringOf("items[i].name")
    pdf_template = jResp.StringOf("items[i].pdf_template")
    document_type = jResp.StringOf("items[i].document_type")
    Text_prefix = jResp.StringOf("items[i].settings.text_prefix")
    Text = jResp.StringOf("items[i].settings.text")
    Subject = jResp.StringOf("items[i].settings.email.subject")
    Message = jResp.StringOf("items[i].settings.email.message")
    i = i + 1
Loop

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": ""
    }
  ]
}