Chilkat Online Tools

phpExt / New FreshBooks / Delete Task

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.

// {
//   "task": {
//     "vis_state": 1
//   }
// }

$json = new CkJsonObject();
$json->UpdateInt('task.vis_state',1);

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');

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

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}',$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)

// {
//   "response": {
//     "result": {
//       "task": {
//         "billable": true,
//         "description": "Hourly rate for doing positive things",
//         "id": 74830,
//         "name": "Saving Earth",
//         "rate": {
//           "amount": "1000.00",
//           "code": "USD"
//         },
//         "taskid": 74830,
//         "tax1": 0,
//         "tax2": 0,
//         "tdesc": "Hourly rate for doing positive things",
//         "tname": "Saving Earth",
//         "updated": "2019-04-24 14:39:45",
//         "vis_state": 1
//       }
//     }
//   }
// }

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

$Billable = $jResp->BoolOf('response.result.task.billable');
$Description = $jResp->stringOf('response.result.task.description');
$Id = $jResp->IntOf('response.result.task.id');
$Name = $jResp->stringOf('response.result.task.name');
$Amount = $jResp->stringOf('response.result.task.rate.amount');
$Code = $jResp->stringOf('response.result.task.rate.code');
$Taskid = $jResp->IntOf('response.result.task.taskid');
$Tax1 = $jResp->IntOf('response.result.task.tax1');
$Tax2 = $jResp->IntOf('response.result.task.tax2');
$Tdesc = $jResp->stringOf('response.result.task.tdesc');
$Tname = $jResp->stringOf('response.result.task.tname');
$Updated = $jResp->stringOf('response.result.task.updated');
$Vis_state = $jResp->IntOf('response.result.task.vis_state');

?>

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
 "task": {
    "vis_state": 1
   }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}

Postman Collection Item JSON

{
  "name": "Delete Task",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n \"task\": {\n    \"vis_state\": 1\n   }\n}\n"
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "projects",
        "tasks",
        "{{taskId}}"
      ]
    }
  },
  "response": [
    {
      "name": "Delete Task",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n \"task\": {\n    \"vis_state\": 1\n   }\n}\n"
        },
        "url": {
          "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks/{{taskId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "accounting",
            "account",
            "{{accountId}}",
            "projects",
            "tasks",
            "{{taskId}}"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUQ1lZBwUXEQoWWRFTGhgCH1UXUAFSC1tdBgdTVlQNAglRUlMbAg5KRgVTB1IAUltSVAsADlsNAABHFQdQDUAHOQ=="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:39:45 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:39:45 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17369-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"result\": {\n            \"task\": {\n                \"billable\": true,\n                \"description\": \"Hourly rate for doing positive things\",\n                \"id\": 74830,\n                \"name\": \"Saving Earth\",\n                \"rate\": {\n                    \"amount\": \"1000.00\",\n                    \"code\": \"USD\"\n                },\n                \"taskid\": 74830,\n                \"tax1\": 0,\n                \"tax2\": 0,\n                \"tdesc\": \"Hourly rate for doing positive things\",\n                \"tname\": \"Saving Earth\",\n                \"updated\": \"2019-04-24 14:39:45\",\n                \"vis_state\": 1\n            }\n        }\n    }\n}"
    }
  ]
}