Chilkat Online Tools

Swift3 / New FreshBooks / Update Project

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.

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

    let json = CkoJsonObject()!
    json.update("project.title", value: "K2 Hiking Guide")
    json.update("project.due_date", value: "2019-04-20")
    json.updateInt("project.client_id", value: 123)

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

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

    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", 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)

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

    var id: Int
    var identity_id: Int
    var role: String?
    var first_name: String?
    var last_name: String?
    var email: String?
    var company: String?
    var active: Bool
    var name: String?
    var value: Bool

    var Id: Int = jResp.int(of: "project.id").intValue
    var Title: String? = jResp.string(of: "project.title")
    var Description: String? = jResp.string(of: "project.description")
    var Due_date: String? = jResp.string(of: "project.due_date")
    var Client_id: Int = jResp.int(of: "project.client_id").intValue
    var Internal: Bool = jResp.bool(of: "project.internal")
    var Budget: String? = jResp.string(of: "project.budget")
    var Fixed_price: String? = jResp.string(of: "project.fixed_price")
    var Rate: String? = jResp.string(of: "project.rate")
    var Billing_method: String? = jResp.string(of: "project.billing_method")
    var Project_type: String? = jResp.string(of: "project.project_type")
    var Active: Bool = jResp.bool(of: "project.active")
    var Complete: Bool = jResp.bool(of: "project.complete")
    var Sample: Bool = jResp.bool(of: "project.sample")
    var Created_at: String? = jResp.string(of: "project.created_at")
    var Updated_at: String? = jResp.string(of: "project.updated_at")
    var Logged_duration: String? = jResp.string(of: "project.logged_duration")
    var Billed_amount: String? = jResp.string(of: "project.billed_amount")
    var Billed_status: String? = jResp.string(of: "project.billed_status")
    var Retainer_id: String? = jResp.string(of: "project.retainer_id")
    var GroupId: Int = jResp.int(of: "project.group.id").intValue
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "project.services").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "project.group.members").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.int(of: "project.group.members[i].id").intValue
        identity_id = jResp.int(of: "project.group.members[i].identity_id").intValue
        role = jResp.string(of: "project.group.members[i].role")
        first_name = jResp.string(of: "project.group.members[i].first_name")
        last_name = jResp.string(of: "project.group.members[i].last_name")
        email = jResp.string(of: "project.group.members[i].email")
        company = jResp.string(of: "project.group.members[i].company")
        active = jResp.bool(of: "project.group.members[i].active")
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "project.group.pending_invitations").intValue
    while i < count_i {
        jResp.i = i
        i = i + 1
    }

    i = 0
    count_i = jResp.size(ofArray: "abilities").intValue
    while i < count_i {
        jResp.i = i
        name = jResp.string(of: "abilities[i].name")
        value = jResp.bool(of: "abilities[i].value")
        i = i + 1
    }


}

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