Chilkat Online Tools

Objective-C / easybill REST API / Update attachment

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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>"
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"created_at" value: @"<date>"];
[json UpdateNull: @"customer_id"];
[json UpdateNull: @"document_id"];
[json UpdateString: @"file_name" value: @"<string>"];
[json UpdateString: @"id" value: @"<long>"];
[json UpdateNull: @"project_id"];
[json UpdateString: @"size" value: @"<integer>"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Authorization" value: @"{{apiKey}}"];
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api.easybill.de/rest/v1/attachments/:id" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

NSString *created_at = [jResp StringOf: @"created_at"];
NSString *customer_id = [jResp StringOf: @"customer_id"];
NSString *document_id = [jResp StringOf: @"document_id"];
NSString *file_name = [jResp StringOf: @"file_name"];
NSString *id = [jResp StringOf: @"id"];
NSString *project_id = [jResp StringOf: @"project_id"];
NSString *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": ""
    }
  ]
}