Swift3 / easybill REST API / Fetch PDF Templates list
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("type", value: "DUNNING,CREDIT")
http.setRequestHeader("Authorization", value: "{{apiKey}}")
http.setRequestHeader("Accept", value: "application/json")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://api.easybill.de/rest/v1/pdf-templates", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var id: String?
var name: String?
var pdf_template: String?
var document_type: String?
var Text_prefix: String?
var Text: String?
var Subject: String?
var Message: String?
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "items").intValue
while i < count_i {
jResp.i = i
id = jResp.string(of: "items[i].id")
name = jResp.string(of: "items[i].name")
pdf_template = jResp.string(of: "items[i].pdf_template")
document_type = jResp.string(of: "items[i].document_type")
Text_prefix = jResp.string(of: "items[i].settings.text_prefix")
Text = jResp.string(of: "items[i].settings.text")
Subject = jResp.string(of: "items[i].settings.email.subject")
Message = jResp.string(of: "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": ""
}
]
}