Chilkat Online Tools

Ruby / New FreshBooks / Update Project

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

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

# The following JSON is sent in the request body.

# {
#   "project": {
#     "title": "K2 Hiking Guide",
#     "due_date": "2019-04-20",
#     "client_id": 123
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("project.title","K2 Hiking Guide")
json.UpdateString("project.due_date","2019-04-20")
json.UpdateInt("project.client_id",123)

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

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "project": {
#     "id": 3018266,
#     "title": "K2 Hiking Guide",
#     "description": null,
#     "due_date": "2019-04-20",
#     "client_id": 31006,
#     "internal": false,
#     "budget": null,
#     "fixed_price": "3000.00",
#     "rate": null,
#     "billing_method": null,
#     "project_type": "fixed_price",
#     "active": true,
#     "complete": false,
#     "sample": false,
#     "created_at": "2019-05-08T20:06:55",
#     "updated_at": "2019-05-08T20:07:37",
#     "logged_duration": null,
#     "services": [
#     ],
#     "billed_amount": "0.00",
#     "billed_status": "unbilled",
#     "retainer_id": null,
#     "group": {
#       "id": 5049390,
#       "members": [
#         {
#           "id": 6578346,
#           "identity_id": 37256,
#           "role": "owner",
#           "first_name": "Marshall",
#           "last_name": "Johnston",
#           "email": "api.freshbooks@gmail.com",
#           "company": "Postman Sandbox",
#           "active": true
#         }
#       ],
#       "pending_invitations": [
#       ]
#     }
#   },
#   "abilities": [
#     {
#       "name": "can_edit",
#       "value": true
#     },
#     {
#       "name": "can_archive",
#       "value": true
#     },
#     {
#       "name": "can_generate_invoice",
#       "value": true
#     },
#     {
#       "name": "can_delete",
#       "value": true
#     },
#     {
#       "name": "can_invite_team_member",
#       "value": true
#     },
#     {
#       "name": "can_manage_services",
#       "value": true
#     },
#     {
#       "name": "can_edit_hourly_budget",
#       "value": true
#     },
#     {
#       "name": "can_view_fixed_price",
#       "value": true
#     },
#     {
#       "name": "can_edit_fixed_price",
#       "value": true
#     },
#     {
#       "name": "can_edit_end_date",
#       "value": true
#     },
#     {
#       "name": "can_edit_flat_rate",
#       "value": true
#     },
#     {
#       "name": "can_edit_project_type",
#       "value": true
#     },
#     {
#       "name": "can_edit_title",
#       "value": true
#     },
#     {
#       "name": "can_view_review_tab",
#       "value": true
#     },
#     {
#       "name": "can_view_discuss_tab",
#       "value": true
#     },
#     {
#       "name": "can_track_time",
#       "value": true
#     },
#     {
#       "name": "can_create_comment",
#       "value": true
#     }
#   ]
# }

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

Id = jResp.IntOf("project.id")
Title = jResp.stringOf("project.title")
Description = jResp.stringOf("project.description")
Due_date = jResp.stringOf("project.due_date")
Client_id = jResp.IntOf("project.client_id")
Internal = jResp.BoolOf("project.internal")
Budget = jResp.stringOf("project.budget")
Fixed_price = jResp.stringOf("project.fixed_price")
Rate = jResp.stringOf("project.rate")
Billing_method = jResp.stringOf("project.billing_method")
Project_type = jResp.stringOf("project.project_type")
Active = jResp.BoolOf("project.active")
Complete = jResp.BoolOf("project.complete")
Sample = jResp.BoolOf("project.sample")
Created_at = jResp.stringOf("project.created_at")
Updated_at = jResp.stringOf("project.updated_at")
Logged_duration = jResp.stringOf("project.logged_duration")
Billed_amount = jResp.stringOf("project.billed_amount")
Billed_status = jResp.stringOf("project.billed_status")
Retainer_id = jResp.stringOf("project.retainer_id")
GroupId = jResp.IntOf("project.group.id")
i = 0
count_i = jResp.SizeOfArray("project.services")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("project.group.members")
while i < count_i
    jResp.put_I(i)
    id = jResp.IntOf("project.group.members[i].id")
    identity_id = jResp.IntOf("project.group.members[i].identity_id")
    role = jResp.stringOf("project.group.members[i].role")
    first_name = jResp.stringOf("project.group.members[i].first_name")
    last_name = jResp.stringOf("project.group.members[i].last_name")
    email = jResp.stringOf("project.group.members[i].email")
    company = jResp.stringOf("project.group.members[i].company")
    active = jResp.BoolOf("project.group.members[i].active")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("project.group.pending_invitations")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("abilities")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("abilities[i].name")
    value = jResp.BoolOf("abilities[i].value")
    i = i + 1
end

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "project": {
    "title": "K2 Hiking Guide",
    "due_date": "2019-04-20",
    "client_id": {{customerId}}
  }
}'
https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}

Postman Collection Item JSON

{
  "name": "Update Project",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"project\": {\n    \"title\": \"K2 Hiking Guide\",\n    \"due_date\": \"2019-04-20\",\n    \"client_id\": {{customerId}}\n  }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "projects",
        "business",
        "{{businessId}}",
        "projects",
        "{{projectId}}"
      ]
    },
    "description": "Update project with project title. \n\n*`client_id` in this case is `customerId`*"
  },
  "response": [
    {
      "name": "Update Project",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"project\": {\n    \"title\": \"K2 Hiking Guide\",\n    \"due_date\": \"2019-04-20\",\n    \"client_id\": {{customerId}}\n  }\n}"
        },
        "url": {
          "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "projects",
            "business",
            "{{businessId}}",
            "projects",
            "{{projectId}}"
          ]
        }
      },
      "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.7.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTBpAVhZWFEMCVlgURFgLAwBMERxUTVIZAwRfVQYGBFpfVFMIVApVAQsYAwNSFUMEUlVSVFNUVF5aWgcEUwAAFR1RBwhCU24="
        },
        {
          "key": "X-RateLimit-Limit",
          "value": "20"
        },
        {
          "key": "X-RateLimit-Remaining",
          "value": "9"
        },
        {
          "key": "X-RateLimit-Reset",
          "value": "1557346118"
        },
        {
          "key": "Retry-After",
          "value": "60"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 08 May 2018 20:07:37 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Content-Length",
          "value": "1552"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Wed, 08 May 2019 20:07:37 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17361-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    \"project\": {\n        \"id\": 3018266,\n        \"title\": \"K2 Hiking Guide\",\n        \"description\": null,\n        \"due_date\": \"2019-04-20\",\n        \"client_id\": 31006,\n        \"internal\": false,\n        \"budget\": null,\n        \"fixed_price\": \"3000.00\",\n        \"rate\": null,\n        \"billing_method\": null,\n        \"project_type\": \"fixed_price\",\n        \"active\": true,\n        \"complete\": false,\n        \"sample\": false,\n        \"created_at\": \"2019-05-08T20:06:55\",\n        \"updated_at\": \"2019-05-08T20:07:37\",\n        \"logged_duration\": null,\n        \"services\": [],\n        \"billed_amount\": \"0.00\",\n        \"billed_status\": \"unbilled\",\n        \"retainer_id\": null,\n        \"group\": {\n            \"id\": 5049390,\n            \"members\": [\n                {\n                    \"id\": 6578346,\n                    \"identity_id\": 37256,\n                    \"role\": \"owner\",\n                    \"first_name\": \"Marshall\",\n                    \"last_name\": \"Johnston\",\n                    \"email\": \"api.freshbooks@gmail.com\",\n                    \"company\": \"Postman Sandbox\",\n                    \"active\": true\n                }\n            ],\n            \"pending_invitations\": []\n        }\n    },\n    \"abilities\": [\n        {\n            \"name\": \"can_edit\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_archive\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_generate_invoice\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_delete\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_invite_team_member\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_manage_services\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_hourly_budget\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_view_fixed_price\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_fixed_price\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_end_date\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_flat_rate\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_project_type\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_edit_title\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_view_review_tab\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_view_discuss_tab\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_track_time\",\n            \"value\": true\n        },\n        {\n            \"name\": \"can_create_comment\",\n            \"value\": true\n        }\n    ]\n}"
    }
  ]
}