Chilkat Online Tools

TCL / easybill REST API / Create attachment

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/rest/v1/attachments"
CkHttpRequest_put_ContentType $req "multipart/form-data"
CkHttpRequest_AddParam $req "file" "<string>"

CkHttpRequest_AddHeader $req "Authorization" "{{apiKey}}"
CkHttpRequest_AddHeader $req "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "api.easybill.de" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "created_at": "<date>",
#   "customer_id": null,
#   "document_id": null,
#   "file_name": "<string>",
#   "id": "<long>",
#   "project_id": null,
#   "size": "<integer>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set created_at [CkJsonObject_stringOf $jResp "created_at"]
set customer_id [CkJsonObject_stringOf $jResp "customer_id"]
set document_id [CkJsonObject_stringOf $jResp "document_id"]
set file_name [CkJsonObject_stringOf $jResp "file_name"]
set id [CkJsonObject_stringOf $jResp "id"]
set project_id [CkJsonObject_stringOf $jResp "project_id"]
set size [CkJsonObject_stringOf $jResp "size"]

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: multipart/form-data"
	-H "Accept: application/json"
	--form 'file=<string>'
https://api.easybill.de/rest/v1/attachments

Postman Collection Item JSON

{
  "name": "Create attachment",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "file",
          "value": "<string>",
          "description": "(Required) ",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/attachments",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "attachments"
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "multipart/form-data"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "file",
              "value": "<string>",
              "description": "(Required) ",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/attachments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"created_at\": \"<date>\",\n  \"customer_id\": null,\n  \"document_id\": null,\n  \"file_name\": \"<string>\",\n  \"id\": \"<long>\",\n  \"project_id\": null,\n  \"size\": \"<integer>\"\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "multipart/form-data"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "file",
              "value": "<string>",
              "description": "(Required) ",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/attachments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments"
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}