Chilkat Online Tools

Ruby / easybill REST API / Fetch PDF Templates list

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("type","DUNNING,CREDIT")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/pdf-templates",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# 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 = jResp.SizeOfArray("items")
while i < count_i
    jResp.put_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
end

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