Chilkat Online Tools

Ruby / New FreshBooks / Update Service Rates

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_service_rate": {
#     "rate": 1065,
#     "service_id": "3600268",
#     "project_id": "2991018"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("project_service_rate.rate",1065)
json.UpdateString("project_service_rate.service_id","3600268")
json.UpdateString("project_service_rate.project_id","2991018")

# 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/comments/business/{{businessId}}/project/{{projectId}}/service/{{serviceId}}/rate",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_service_rate": {
#     "rate": "1020.00",
#     "service_id": 3600268,
#     "business_id": 1966214,
#     "project_id": 2991018
#   }
# }

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

Rate = jResp.stringOf("project_service_rate.rate")
Service_id = jResp.IntOf("project_service_rate.service_id")
Business_id = jResp.IntOf("project_service_rate.business_id")
Project_id = jResp.IntOf("project_service_rate.project_id")

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "project_service_rate": {
        "rate": 1065,
        "service_id": "3600268",
        "project_id": "2991018"
    }
}'
https://api.freshbooks.com/comments/business/{{businessId}}/project/{{projectId}}/service/{{serviceId}}/rate

Postman Collection Item JSON

{
  "name": "Update Service Rates",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"project_service_rate\": {\n        \"rate\": 1065,\n        \"service_id\": \"3600268\",\n        \"project_id\": \"2991018\"\n    }\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/project/{{projectId}}/service/{{serviceId}}/rate",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "comments",
        "business",
        "{{businessId}}",
        "project",
        "{{projectId}}",
        "service",
        "{{serviceId}}",
        "rate"
      ]
    },
    "description": "You will need to update each project service independently with this endpoint"
  },
  "response": [
    {
      "name": "Update Project Service Rates",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "url": {
          "raw": "https://api.freshbooks.com/comments/business/1966214/project/2991018/service/3600268/rate",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "comments",
            "business",
            "1966214",
            "project",
            "2991018",
            "service",
            "3600268",
            "rate"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-Version",
          "value": "1904.25.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTGtBVhdPCFIEbBAFQlJPFAZLXEUWAgcNQUUJDlRVRz0VBhBGC1sHZ0pVRlZHFVEdUR1TVA8OV1NTAAYJXFJQAAcEUUgcBx9AA1BaAVZcUl5ZBlQAUlgFAkMfBAVaRAQ7"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 25 Apr 2018 17:20:02 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Content-Length",
          "value": "115"
        },
        {
          "key": "Date",
          "value": "Thu, 25 Apr 2019 17:20:02 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17368-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_service_rate\": {\n        \"rate\": \"1020.00\",\n        \"service_id\": 3600268,\n        \"business_id\": 1966214,\n        \"project_id\": 2991018\n    }\n}"
    }
  ]
}