Chilkat Online Tools

Swift3 / New FreshBooks / Update a Time Entry

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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
    //   }
    // }

    let json = CkoJsonObject()!
    json.updateBool("time_entry.is_logged", value: true)
    json.updateInt("time_entry.duration", value: 600)
    json.update("time_entry.note", value: "Updated Note")
    json.update("time_entry.started_at", value: "2016-08-16T18:03:28.000Z")
    json.update("time_entry.timer.id", value: "2936")
    json.updateInt("time_entry.client_id", value: 123)
    json.updateInt("time_entry.project_id", value: 123)

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"
    http.setRequestHeader("Content-Type", value: "")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.freshbooks.com/timetracking/business/{{businessId}}/time_entries/{{timeEntryId}}", textData: sbRequestBody, charset: "utf-8", contentType: "", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var Id: Int = jResp.int(of: "time_entry.id").intValue
    var Identity_id: Int = jResp.int(of: "time_entry.identity_id").intValue
    var Timer: String? = jResp.string(of: "time_entry.timer")
    var Is_logged: Bool = jResp.bool(of: "time_entry.is_logged")
    var Started_at: String? = jResp.string(of: "time_entry.started_at")
    var Created_at: String? = jResp.string(of: "time_entry.created_at")
    var Duration: Int = jResp.int(of: "time_entry.duration").intValue
    var Client_id: Int = jResp.int(of: "time_entry.client_id").intValue
    var Project_id: Int = jResp.int(of: "time_entry.project_id").intValue
    var Pending_client: String? = jResp.string(of: "time_entry.pending_client")
    var Pending_project: String? = jResp.string(of: "time_entry.pending_project")
    var Pending_task: String? = jResp.string(of: "time_entry.pending_task")
    var Task_id: String? = jResp.string(of: "time_entry.task_id")
    var Service_id: String? = jResp.string(of: "time_entry.service_id")
    var Note: String? = jResp.string(of: "time_entry.note")
    var Active: Bool = jResp.bool(of: "time_entry.active")
    var Billable: Bool = jResp.bool(of: "time_entry.billable")
    var Billed: Bool = jResp.bool(of: "time_entry.billed")
    var Internal: Bool = jResp.bool(of: "time_entry.internal")
    var Retainer_id: String? = jResp.string(of: "time_entry.retainer_id")

}

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}"
    }
  ]
}