Chilkat Online Tools

Objective-C / New FreshBooks / Delete Retainer

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.

// {
//   "retainer": {
//     "active": false
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateBool: @"retainer.active" value: NO];

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

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

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}" 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)

// {
//   "retainer": {
//     "id": 2248,
//     "business_id": 1966214,
//     "system_id": 4236410,
//     "invoice_profile_id": null,
//     "client_user_id": 75162,
//     "start_date": "2019-06-03",
//     "next_period_start_date": "2019-07-03",
//     "fee": "20.00",
//     "excess_rate": "700.00",
//     "budgeted_time": 180000,
//     "active": false,
//     "created_at": "2019-06-03T15:42:49",
//     "updated_at": "2019-06-03T18:22:53"
//   }
// }

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

int Id = [[jResp IntOf: @"retainer.id"] intValue];
int Business_id = [[jResp IntOf: @"retainer.business_id"] intValue];
int System_id = [[jResp IntOf: @"retainer.system_id"] intValue];
NSString *Invoice_profile_id = [jResp StringOf: @"retainer.invoice_profile_id"];
int Client_user_id = [[jResp IntOf: @"retainer.client_user_id"] intValue];
NSString *Start_date = [jResp StringOf: @"retainer.start_date"];
NSString *Next_period_start_date = [jResp StringOf: @"retainer.next_period_start_date"];
NSString *Fee = [jResp StringOf: @"retainer.fee"];
NSString *Excess_rate = [jResp StringOf: @"retainer.excess_rate"];
int Budgeted_time = [[jResp IntOf: @"retainer.budgeted_time"] intValue];
BOOL Active = [jResp BoolOf: @"retainer.active"];
NSString *Created_at = [jResp StringOf: @"retainer.created_at"];
NSString *Updated_at = [jResp StringOf: @"retainer.updated_at"];

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "retainer": {
        "active": false
    }
}'
https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}

Postman Collection Item JSON

{
  "name": "Delete Retainer",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"retainer\": {\n        \"active\": false\n    }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "comments",
        "business",
        "{{businessId}}",
        "retainer",
        "{{retainerId}}"
      ]
    },
    "description": "A retainer is deleted by changing the active status to \"false\". It can be undeleted by changing active status back to true."
  },
  "response": [
    {
      "name": "Delete Retainer Success",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"retainer\": {\n        \"active\": false\n    }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/retainer/{{retainerId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "comments",
            "business",
            "{{businessId}}",
            "retainer",
            "{{retainerId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-Version",
          "value": "1905.33.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEFUWWQtWXUYcQQBKDkQTUAdeRFIVBwpWVkJGTVIbARlXVgQCClFWV1sGUAlXAAoEAR9QCE0TAwtWVgNWVVYACFcAXQdaBhMbAAVdRVY/"
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "0"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1559586233"
        },
        {
          "key": "Retry-After",
          "value": "59"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Sun, 03 Jun 2018 18:22:53 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Content-Length",
          "value": "350"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Mon, 03 Jun 2019 18:22:53 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17376-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"retainer\": {\n        \"id\": 2248,\n        \"business_id\": 1966214,\n        \"system_id\": 4236410,\n        \"invoice_profile_id\": null,\n        \"client_user_id\": 75162,\n        \"start_date\": \"2019-06-03\",\n        \"next_period_start_date\": \"2019-07-03\",\n        \"fee\": \"20.00\",\n        \"excess_rate\": \"700.00\",\n        \"budgeted_time\": 180000,\n        \"active\": false,\n        \"created_at\": \"2019-06-03T15:42:49\",\n        \"updated_at\": \"2019-06-03T18:22:53\"\n    }\n}"
    }
  ]
}