PureBasic / New FreshBooks / Update a Time Entry
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "time_entry": {
; "is_logged": true,
; "duration": 600,
; "note": "Updated Note",
; "started_at": "2016-08-16T18:03:28.000Z",
; "timer": {
; "id": "2936"
; },
; "client_id": 123,
; "project_id": 123
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateBool(json,"time_entry.is_logged",1)
CkJsonObject::ckUpdateInt(json,"time_entry.duration",600)
CkJsonObject::ckUpdateString(json,"time_entry.note","Updated Note")
CkJsonObject::ckUpdateString(json,"time_entry.started_at","2016-08-16T18:03:28.000Z")
CkJsonObject::ckUpdateString(json,"time_entry.timer.id","2936")
CkJsonObject::ckUpdateInt(json,"time_entry.client_id",123)
CkJsonObject::ckUpdateInt(json,"time_entry.project_id",123)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",sbRequestBody,"utf-8","",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "time_entry": {
; "id": 47902064,
; "identity_id": 1882548,
; "timer": null,
; "is_logged": true,
; "started_at": "2016-08-16T18:03:28Z",
; "created_at": "2019-04-24T18:44:50Z",
; "duration": 600,
; "client_id": 31006,
; "project_id": 2989082,
; "pending_client": null,
; "pending_project": null,
; "pending_task": null,
; "task_id": null,
; "service_id": null,
; "note": "Updated Note",
; "active": true,
; "billable": false,
; "billed": false,
; "internal": false,
; "retainer_id": null
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id.i = CkJsonObject::ckIntOf(jResp,"time_entry.id")
Identity_id.i = CkJsonObject::ckIntOf(jResp,"time_entry.identity_id")
Timer.s = CkJsonObject::ckStringOf(jResp,"time_entry.timer")
Is_logged.i = CkJsonObject::ckBoolOf(jResp,"time_entry.is_logged")
Started_at.s = CkJsonObject::ckStringOf(jResp,"time_entry.started_at")
Created_at.s = CkJsonObject::ckStringOf(jResp,"time_entry.created_at")
Duration.i = CkJsonObject::ckIntOf(jResp,"time_entry.duration")
Client_id.i = CkJsonObject::ckIntOf(jResp,"time_entry.client_id")
Project_id.i = CkJsonObject::ckIntOf(jResp,"time_entry.project_id")
Pending_client.s = CkJsonObject::ckStringOf(jResp,"time_entry.pending_client")
Pending_project.s = CkJsonObject::ckStringOf(jResp,"time_entry.pending_project")
Pending_task.s = CkJsonObject::ckStringOf(jResp,"time_entry.pending_task")
Task_id.s = CkJsonObject::ckStringOf(jResp,"time_entry.task_id")
Service_id.s = CkJsonObject::ckStringOf(jResp,"time_entry.service_id")
Note.s = CkJsonObject::ckStringOf(jResp,"time_entry.note")
Active.i = CkJsonObject::ckBoolOf(jResp,"time_entry.active")
Billable.i = CkJsonObject::ckBoolOf(jResp,"time_entry.billable")
Billed.i = CkJsonObject::ckBoolOf(jResp,"time_entry.billed")
Internal.i = CkJsonObject::ckBoolOf(jResp,"time_entry.internal")
Retainer_id.s = CkJsonObject::ckStringOf(jResp,"time_entry.retainer_id")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: "
-d '{
"time_entry": {
"is_logged": true,
"duration": 600,
"note": "Updated Note",
"started_at": "2016-08-16T18:03:28.000Z",
"timer": {
"id": "2936"
},
"client_id": {{clientId}},
"project_id": {{projectId}}
}
}'
https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}
Postman Collection Item JSON
{
"name": "Update a Time Entry",
"request": {
"method": "PUT",
"header": [
{
"key": "",
"name": "Content-Type",
"value": "",
"type": "text",
"disabled": true
},
{
"key": "Content-Type",
"value": "",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"time_entry\": {\n \"is_logged\": true,\n \"duration\": 600,\n \"note\": \"Updated Note\",\n \"started_at\": \"2016-08-16T18:03:28.000Z\",\n \"timer\": {\n \"id\": \"2936\"\n },\n \"client_id\": {{clientId}},\n \"project_id\": {{projectId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries",
"{{timeEntryId}}"
]
}
},
"response": [
{
"name": "Update a Time Entry",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"time_entry\": {\n \"is_logged\": true,\n \"duration\": 600,\n \"note\": \"Updated Note\",\n \"started_at\": \"2016-08-16T18:03:28.000Z\",\n \"timer\": {\n \"id\": \"2936\"\n },\n \"client_id\": {{clientId}},\n \"project_id\": {{projectId}}\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"timetracking",
"business",
"{{businessId}}",
"time_entries",
"{{timeEntryId}}"
]
}
},
"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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNFlkPXT1dVkBASktLBEIORhAHUw0VDw5dbFUKFRBOExtWSAEYAlRVVlcIUghUCgACBAFUCE0DVAdORgQBUVFaCQoEVQVVDwVWBFYTGlUDChAHbQ=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:45:14 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "450"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:45:14 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-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 \"time_entry\": {\n \"id\": 47902064,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T18:03:28Z\",\n \"created_at\": \"2019-04-24T18:44:50Z\",\n \"duration\": 600,\n \"client_id\": 31006,\n \"project_id\": 2989082,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Updated Note\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null\n }\n}"
}
]
}