Chilkat Online Tools

Swift / easybill REST API / Send document

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

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "to": "<string>",
    //   "cc": "<string>",
    //   "from": "<string>",
    //   "subject": "<string>",
    //   "message": "<string>",
    //   "date": "<date>",
    //   "send_by_self": "<boolean>",
    //   "send_with_attachment": "true",
    //   "document_file_type": "default",
    //   "post_send_type": "post_send_type_prio"
    // }

    let json = CkoJsonObject()
    json.UpdateString("to", value: "<string>")
    json.UpdateString("cc", value: "<string>")
    json.UpdateString("from", value: "<string>")
    json.UpdateString("subject", value: "<string>")
    json.UpdateString("message", value: "<string>")
    json.UpdateString("date", value: "<date>")
    json.UpdateString("send_by_self", value: "<boolean>")
    json.UpdateString("send_with_attachment", value: "true")
    json.UpdateString("document_file_type", value: "default")
    json.UpdateString("post_send_type", value: "post_send_type_prio")

    http.SetRequestHeader("Authorization", value: "{{apiKey}}")
    http.SetRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.PostJson3("https://api.easybill.de/rest/v1/documents/:id/send/:type", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode != 204 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Response Body:")
        print("\(resp!.BodyStr)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil
    print("Success.")

}

Curl Command

curl -X POST
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-d '{
  "to": "<string>",
  "cc": "<string>",
  "from": "<string>",
  "subject": "<string>",
  "message": "<string>",
  "date": "<date>",
  "send_by_self": "<boolean>",
  "send_with_attachment": "true",
  "document_file_type": "default",
  "post_send_type": "post_send_type_prio"
}'
https://api.easybill.de/rest/v1/documents/:id/send/:type

Postman Collection Item JSON

{
  "name": "Send document",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"to\": \"<string>\",\n  \"cc\": \"<string>\",\n  \"from\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"message\": \"<string>\",\n  \"date\": \"<date>\",\n  \"send_by_self\": \"<boolean>\",\n  \"send_with_attachment\": \"true\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_prio\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/documents/:id/send/:type",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "documents",
        ":id",
        "send",
        ":type"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of document"
        },
        {
          "key": "type",
          "value": "fax",
          "description": "(Required) "
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"to\": \"<string>\",\n  \"cc\": \"<string>\",\n  \"from\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"message\": \"<string>\",\n  \"date\": \"<date>\",\n  \"send_by_self\": \"<boolean>\",\n  \"send_with_attachment\": \"true\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_prio\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/documents/:id/send/:type",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "send",
            ":type"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "type"
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"to\": \"<string>\",\n  \"cc\": \"<string>\",\n  \"from\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"message\": \"<string>\",\n  \"date\": \"<date>\",\n  \"send_by_self\": \"<boolean>\",\n  \"send_with_attachment\": \"true\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_prio\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/documents/:id/send/:type",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "send",
            ":type"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "type"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"to\": \"<string>\",\n  \"cc\": \"<string>\",\n  \"from\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"message\": \"<string>\",\n  \"date\": \"<date>\",\n  \"send_by_self\": \"<boolean>\",\n  \"send_with_attachment\": \"true\",\n  \"document_file_type\": \"default\",\n  \"post_send_type\": \"post_send_type_prio\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/documents/:id/send/:type",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "documents",
            ":id",
            "send",
            ":type"
          ],
          "variable": [
            {
              "key": "id"
            },
            {
              "key": "type"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}