Chilkat Online Tools

phpExt / easybill REST API / Update attachment

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

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

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

$json = new CkJsonObject();
$json->UpdateString('created_at','<date>');
$json->UpdateNull('customer_id');
$json->UpdateNull('document_id');
$json->UpdateString('file_name','<string>');
$json->UpdateString('id','<long>');
$json->UpdateNull('project_id');
$json->UpdateString('size','<integer>');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Authorization','{{apiKey}}');
$http->SetRequestHeader('Accept','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.easybill.de/rest/v1/attachments/:id',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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 PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "created_at": "<date>",
  "customer_id": null,
  "document_id": null,
  "file_name": "<string>",
  "id": "<long>",
  "project_id": null,
  "size": "<integer>"
}'
https://api.easybill.de/rest/v1/attachments/:id

Postman Collection Item JSON

{
  "name": "Update attachment",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/attachments/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "attachments",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of attachment"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/attachments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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": "Invalid attachment",
      "originalRequest": {
        "method": "PUT",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/attachments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "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  \"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}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/attachments/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "attachments",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}