Chilkat Online Tools

Swift / New FreshBooks / Add Business

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.

    // {
    //   "name": "Kevin's Corral",
    //   "date_format": "mm/dd/yyyy",
    //   "address_attributes": {
    //     "country": "Canada"
    //   },
    //   "phone_number_attributes": null
    // }

    let json = CkoJsonObject()
    json.UpdateString("name", value: "Kevin's Corral")
    json.UpdateString("date_format", value: "mm/dd/yyyy")
    json.UpdateString("address_attributes.country", value: "Canada")
    json.UpdateNull("phone_number_attributes")

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

    var resp: CkoHttpResponse? = http.PostJson3("https://api.freshbooks.com/auth/api/v1/users/business", contentType: "application/json", json: json)
    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)

    // {
    //   "response": {
    //     "id": 1986590,
    //     "name": "Kevin's Corral",
    //     "account_id": "lwy0vG",
    //     "business_group": {
    //       "id": 4977602,
    //       "category": "business",
    //       "members": [
    //         {
    //           "id": 6487912,
    //           "group_id": 4977602,
    //           "role": "owner",
    //           "identity_id": 37256,
    //           "first_name": "Marshall",
    //           "last_name": "Johnston",
    //           "email": "api.freshbooks@gmail.com",
    //           "company": "Kevin's Corral",
    //           "business_id": 1986590,
    //           "unacknowledged_change": false,
    //           "active": true
    //         }
    //       ]
    //     },
    //     "date_format": "mm/dd/yyyy",
    //     "address": {
    //       "id": 2448988,
    //       "street": null,
    //       "city": null,
    //       "province": null,
    //       "country": "Canada",
    //       "postal_code": null
    //     },
    //     "phone_number": null,
    //     "business_clients": [
    //     ]
    //   }
    // }

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

    let Date_format = CkoDtObj()
    var id: Int
    var group_id: Int
    var role: String?
    var identity_id: Int
    var first_name: String?
    var last_name: String?
    var email: String?
    var company: String?
    var business_id: Int
    var unacknowledged_change: Bool
    var active: Bool

    var Id: Int = jResp.IntOf("response.id").intValue
    var Name: String? = jResp.StringOf("response.name")
    var Account_id: String? = jResp.StringOf("response.account_id")
    var Business_groupId: Int = jResp.IntOf("response.business_group.id").intValue
    var Category: String? = jResp.StringOf("response.business_group.category")
    jResp.DtOf("response.date_format", bLocal: false, dt: Date_format)
    var AddressId: Int = jResp.IntOf("response.address.id").intValue
    var Street: String? = jResp.StringOf("response.address.street")
    var City: String? = jResp.StringOf("response.address.city")
    var Province: String? = jResp.StringOf("response.address.province")
    var Country: String? = jResp.StringOf("response.address.country")
    var Postal_code: String? = jResp.StringOf("response.address.postal_code")
    var Phone_number: String? = jResp.StringOf("response.phone_number")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("response.business_group.members").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.IntOf("response.business_group.members[i].id").intValue
        group_id = jResp.IntOf("response.business_group.members[i].group_id").intValue
        role = jResp.StringOf("response.business_group.members[i].role")
        identity_id = jResp.IntOf("response.business_group.members[i].identity_id").intValue
        first_name = jResp.StringOf("response.business_group.members[i].first_name")
        last_name = jResp.StringOf("response.business_group.members[i].last_name")
        email = jResp.StringOf("response.business_group.members[i].email")
        company = jResp.StringOf("response.business_group.members[i].company")
        business_id = jResp.IntOf("response.business_group.members[i].business_id").intValue
        unacknowledged_change = jResp.BoolOf("response.business_group.members[i].unacknowledged_change")
        active = jResp.BoolOf("response.business_group.members[i].active")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("response.business_clients").intValue
    while i < count_i {
        jResp.I = i
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "name": "Kevin\'s Corral",
    "date_format": "mm/dd/yyyy",
    "address_attributes": {
        "country": "Canada"
    },
    "phone_number_attributes": null
}'
https://api.freshbooks.com/auth/api/v1/users/business

Postman Collection Item JSON

{
  "name": "Add Business",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"Kevin's Corral\",\n    \"date_format\": \"mm/dd/yyyy\",\n    \"address_attributes\": {\n        \"country\": \"Canada\"\n    },\n    \"phone_number_attributes\": null\n}"
    },
    "url": {
      "raw": "https://api.freshbooks.com/auth/api/v1/users/business",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "auth",
        "api",
        "v1",
        "users",
        "business"
      ]
    }
  },
  "response": [
    {
      "name": "Add Business",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"Kevin's Corral\",\n    \"date_format\": \"mm/dd/yyyy\",\n    \"address_attributes\": {\n        \"country\": \"Canada\"\n    },\n    \"phone_number_attributes\": null\n}"
        },
        "url": {
          "raw": "https://my.freshbooks.com/service/api/auth/api/v1/users/business",
          "protocol": "https",
          "host": [
            "my",
            "freshbooks",
            "com"
          ],
          "path": [
            "service",
            "api",
            "auth",
            "api",
            "v1",
            "users",
            "business"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "X-Permitted-Cross-Domain-Policies",
          "value": "none"
        },
        {
          "key": "Referrer-Policy",
          "value": "strict-origin-when-cross-origin"
        },
        {
          "key": "ETag",
          "value": "W/\"ece9403d440d4badd777fca953dd9580\""
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "X-Request-Id",
          "value": "49e5ba95-b7dc-42c7-b0c3-8d61d99d1f39"
        },
        {
          "key": "X-Runtime",
          "value": "0.670145"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVlVSBAUHUFQTGhEhCQ0WQg1UDl1KG39aAV0NVBZSEAEZZQAFCBdyUxAIDVl1XhUUUEJQClxZMF8XTAtWXw4IYQpMFVQyVhZLVVYNCkEUAx5UTVIZBwBXVgUEBFNVWlAIUApQDxQZAx9HDlIAVQpQBQBUV1AFXFUBXUM/"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 25 Apr 2018 16:51:20 GMT"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Date",
          "value": "Thu, 25 Apr 2019 16:51:20 GMT"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17366-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"response\": {\n        \"id\": 1986590,\n        \"name\": \"Kevin's Corral\",\n        \"account_id\": \"lwy0vG\",\n        \"business_group\": {\n            \"id\": 4977602,\n            \"category\": \"business\",\n            \"members\": [\n                {\n                    \"id\": 6487912,\n                    \"group_id\": 4977602,\n                    \"role\": \"owner\",\n                    \"identity_id\": 37256,\n                    \"first_name\": \"Marshall\",\n                    \"last_name\": \"Johnston\",\n                    \"email\": \"api.freshbooks@gmail.com\",\n                    \"company\": \"Kevin's Corral\",\n                    \"business_id\": 1986590,\n                    \"unacknowledged_change\": false,\n                    \"active\": true\n                }\n            ]\n        },\n        \"date_format\": \"mm/dd/yyyy\",\n        \"address\": {\n            \"id\": 2448988,\n            \"street\": null,\n            \"city\": null,\n            \"province\": null,\n            \"country\": \"Canada\",\n            \"postal_code\": null\n        },\n        \"phone_number\": null,\n        \"business_clients\": []\n    }\n}"
    }
  ]
}