Chilkat Online Tools

phpAx / easybill REST API / Update task

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

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

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

// {
//   "name": "<string>",
//   "status": "PROCESSING",
//   "category": null,
//   "category_custom": null,
//   "created_at": "<dateTime>",
//   "customer_id": null,
//   "description": null,
//   "document_id": null,
//   "end_at": "<dateTime>",
//   "finish_at": "<dateTime>",
//   "id": "<long>",
//   "login_id": "<long>",
//   "position_id": null,
//   "priority": "NORMAL",
//   "project_id": null,
//   "start_at": null,
//   "status_percent": null
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('name','<string>');
$json->UpdateString('status','PROCESSING');
$json->UpdateNull('category');
$json->UpdateNull('category_custom');
$json->UpdateString('created_at','<dateTime>');
$json->UpdateNull('customer_id');
$json->UpdateNull('description');
$json->UpdateNull('document_id');
$json->UpdateString('end_at','<dateTime>');
$json->UpdateString('finish_at','<dateTime>');
$json->UpdateString('id','<long>');
$json->UpdateString('login_id','<long>');
$json->UpdateNull('position_id');
$json->UpdateString('priority','NORMAL');
$json->UpdateNull('project_id');
$json->UpdateNull('start_at');
$json->UpdateNull('status_percent');

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://api.easybill.de/rest/v1/tasks/:id',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

$respStatusCode = $resp->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)

// {
//   "name": "<string>",
//   "status": "PROCESSING",
//   "category": null,
//   "category_custom": null,
//   "created_at": "<dateTime>",
//   "customer_id": null,
//   "description": null,
//   "document_id": null,
//   "end_at": "<dateTime>",
//   "finish_at": "<dateTime>",
//   "id": "<long>",
//   "login_id": "<long>",
//   "position_id": null,
//   "priority": "NORMAL",
//   "project_id": null,
//   "start_at": null,
//   "status_percent": null
// }

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

$name = $jResp->stringOf('name');
$status = $jResp->stringOf('status');
$category = $jResp->stringOf('category');
$category_custom = $jResp->stringOf('category_custom');
$created_at = $jResp->stringOf('created_at');
$customer_id = $jResp->stringOf('customer_id');
$description = $jResp->stringOf('description');
$document_id = $jResp->stringOf('document_id');
$end_at = $jResp->stringOf('end_at');
$finish_at = $jResp->stringOf('finish_at');
$id = $jResp->stringOf('id');
$login_id = $jResp->stringOf('login_id');
$position_id = $jResp->stringOf('position_id');
$priority = $jResp->stringOf('priority');
$project_id = $jResp->stringOf('project_id');
$start_at = $jResp->stringOf('start_at');
$status_percent = $jResp->stringOf('status_percent');

?>

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "name": "<string>",
  "status": "PROCESSING",
  "category": null,
  "category_custom": null,
  "created_at": "<dateTime>",
  "customer_id": null,
  "description": null,
  "document_id": null,
  "end_at": "<dateTime>",
  "finish_at": "<dateTime>",
  "id": "<long>",
  "login_id": "<long>",
  "position_id": null,
  "priority": "NORMAL",
  "project_id": null,
  "start_at": null,
  "status_percent": null
}'
https://api.easybill.de/rest/v1/tasks/:id

Postman Collection Item JSON

{
  "name": "Update task",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/tasks/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tasks",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of task"
        }
      ]
    }
  },
  "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  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\n}"
    },
    {
      "name": "Invalid task",
      "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  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":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  \"name\": \"<string>\",\n  \"status\": \"PROCESSING\",\n  \"category\": null,\n  \"category_custom\": null,\n  \"created_at\": \"<dateTime>\",\n  \"customer_id\": null,\n  \"description\": null,\n  \"document_id\": null,\n  \"end_at\": \"<dateTime>\",\n  \"finish_at\": \"<dateTime>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"position_id\": null,\n  \"priority\": \"NORMAL\",\n  \"project_id\": null,\n  \"start_at\": null,\n  \"status_percent\": null\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/tasks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tasks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}