Chilkat Online Tools

Ruby / easybill REST API / Create attachment

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()

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/rest/v1/attachments")
req.put_ContentType("multipart/form-data")
req.AddParam("file","<string>")

req.AddHeader("Authorization","{{apiKey}}")
req.AddHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.SynchronousRequest("api.easybill.de",443,true,req)
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)

# {
#   "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

created_at = jResp.stringOf("created_at")
customer_id = jResp.stringOf("customer_id")
document_id = jResp.stringOf("document_id")
file_name = jResp.stringOf("file_name")
id = jResp.stringOf("id")
project_id = jResp.stringOf("project_id")
size = jResp.stringOf("size")

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