lianja / New FreshBooks / Update Service Rates
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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.
// {
// "project_service_rate": {
// "rate": 1065,
// "service_id": "3600268",
// "project_id": "2991018"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateInt("project_service_rate.rate",1065)
loJson.UpdateString("project_service_rate.service_id","3600268")
loJson.UpdateString("project_service_rate.project_id","2991018")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.freshbooks.com/comments/business/{{businessId}}/project/{{projectId}}/service/{{serviceId}}/rate",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
lcRate = loJResp.StringOf("project_service_rate.rate")
lnService_id = loJResp.IntOf("project_service_rate.service_id")
lnBusiness_id = loJResp.IntOf("project_service_rate.business_id")
lnProject_id = loJResp.IntOf("project_service_rate.project_id")
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
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}"
}
]
}
