Chilkat Online Tools

Mono / 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.

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("type","DUNNING,CREDIT");

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

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/pdf-templates",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// 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

string id;
string name;
string pdf_template;
string document_type;
string Text_prefix;
string Text;
string Subject;
string Message;

int i = 0;
int count_i = jResp.SizeOfArray("items");
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;
}

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