Chilkat Online Tools

TCL / easybill REST API / Update project

Back to Collection Items

load ./chilkat.dll

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

set 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.

# {
#   "name": "<string>",
#   "budget_amount": 0,
#   "budget_time": 0,
#   "customer_id": null,
#   "hourly_rate": "<float>",
#   "id": "<long>",
#   "login_id": "<long>",
#   "note": null,
#   "status": "OPEN",
#   "due_at": null,
#   "budget_notify_frequency": "ALWAYS",
#   "consumed_time": "<integer>",
#   "consumed_amount": "<integer>"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "name" "<string>"
CkJsonObject_UpdateInt $json "budget_amount" 0
CkJsonObject_UpdateInt $json "budget_time" 0
CkJsonObject_UpdateNull $json "customer_id"
CkJsonObject_UpdateString $json "hourly_rate" "<float>"
CkJsonObject_UpdateString $json "id" "<long>"
CkJsonObject_UpdateString $json "login_id" "<long>"
CkJsonObject_UpdateNull $json "note"
CkJsonObject_UpdateString $json "status" "OPEN"
CkJsonObject_UpdateNull $json "due_at"
CkJsonObject_UpdateString $json "budget_notify_frequency" "ALWAYS"
CkJsonObject_UpdateString $json "consumed_time" "<integer>"
CkJsonObject_UpdateString $json "consumed_amount" "<integer>"

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "Authorization" "{{apiKey}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://api.easybill.de/rest/v1/projects/:id" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "name": "<string>",
#   "budget_amount": 0,
#   "budget_time": 0,
#   "customer_id": null,
#   "hourly_rate": "<float>",
#   "id": "<long>",
#   "login_id": "<long>",
#   "note": null,
#   "status": "OPEN",
#   "due_at": null,
#   "budget_notify_frequency": "ALWAYS",
#   "consumed_time": "<integer>",
#   "consumed_amount": "<integer>"
# }

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

set name [CkJsonObject_stringOf $jResp "name"]
set budget_amount [CkJsonObject_IntOf $jResp "budget_amount"]
set budget_time [CkJsonObject_IntOf $jResp "budget_time"]
set customer_id [CkJsonObject_stringOf $jResp "customer_id"]
set hourly_rate [CkJsonObject_stringOf $jResp "hourly_rate"]
set id [CkJsonObject_stringOf $jResp "id"]
set login_id [CkJsonObject_stringOf $jResp "login_id"]
set note [CkJsonObject_stringOf $jResp "note"]
set status [CkJsonObject_stringOf $jResp "status"]
set due_at [CkJsonObject_stringOf $jResp "due_at"]
set budget_notify_frequency [CkJsonObject_stringOf $jResp "budget_notify_frequency"]
set consumed_time [CkJsonObject_stringOf $jResp "consumed_time"]
set consumed_amount [CkJsonObject_stringOf $jResp "consumed_amount"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "name": "<string>",
  "budget_amount": 0,
  "budget_time": 0,
  "customer_id": null,
  "hourly_rate": "<float>",
  "id": "<long>",
  "login_id": "<long>",
  "note": null,
  "status": "OPEN",
  "due_at": null,
  "budget_notify_frequency": "ALWAYS",
  "consumed_time": "<integer>",
  "consumed_amount": "<integer>"
}'
https://api.easybill.de/rest/v1/projects/:id

Postman Collection Item JSON

{
  "name": "Update project",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"name\": \"<string>\",\n  \"budget_amount\": 0,\n  \"budget_time\": 0,\n  \"customer_id\": null,\n  \"hourly_rate\": \"<float>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"note\": null,\n  \"status\": \"OPEN\",\n  \"due_at\": null,\n  \"budget_notify_frequency\": \"ALWAYS\",\n  \"consumed_time\": \"<integer>\",\n  \"consumed_amount\": \"<integer>\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/projects/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "projects",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of project"
        }
      ]
    }
  },
  "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  \"budget_amount\": 0,\n  \"budget_time\": 0,\n  \"customer_id\": null,\n  \"hourly_rate\": \"<float>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"note\": null,\n  \"status\": \"OPEN\",\n  \"due_at\": null,\n  \"budget_notify_frequency\": \"ALWAYS\",\n  \"consumed_time\": \"<integer>\",\n  \"consumed_amount\": \"<integer>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/projects/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "projects",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"name\": \"<string>\",\n  \"budget_amount\": 0,\n  \"budget_time\": 0,\n  \"customer_id\": null,\n  \"hourly_rate\": \"<float>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"note\": null,\n  \"status\": \"OPEN\",\n  \"due_at\": null,\n  \"budget_notify_frequency\": \"ALWAYS\",\n  \"consumed_time\": \"<integer>\",\n  \"consumed_amount\": \"<integer>\"\n}"
    },
    {
      "name": "Invalid project",
      "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  \"budget_amount\": 0,\n  \"budget_time\": 0,\n  \"customer_id\": null,\n  \"hourly_rate\": \"<float>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"note\": null,\n  \"status\": \"OPEN\",\n  \"due_at\": null,\n  \"budget_notify_frequency\": \"ALWAYS\",\n  \"consumed_time\": \"<integer>\",\n  \"consumed_amount\": \"<integer>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/projects/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "projects",
            ":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  \"budget_amount\": 0,\n  \"budget_time\": 0,\n  \"customer_id\": null,\n  \"hourly_rate\": \"<float>\",\n  \"id\": \"<long>\",\n  \"login_id\": \"<long>\",\n  \"note\": null,\n  \"status\": \"OPEN\",\n  \"due_at\": null,\n  \"budget_notify_frequency\": \"ALWAYS\",\n  \"consumed_time\": \"<integer>\",\n  \"consumed_amount\": \"<integer>\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/projects/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "projects",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}