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
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type", value: "application/json")
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "client": {
// "accounting_systemid": "wkMd2g",
// "allow_late_fees": true,
// "allow_late_notifications": true,
// "bus_phone": "",
// "company_industry": null,
// "company_size": null,
// "currency_code": "USD",
// "direct_link_token": null,
// "email": "api.freshbooks@gmail.com",
// "fax": "",
// "fname": "Nicolas",
// "has_retainer": null,
// "home_phone": "555-555-1234",
// "id": 31006,
// "language": "en",
// "last_activity": null,
// "last_login": null,
// "level": 0,
// "lname": "one",
// "mob_phone": "",
// "note": null,
// "notified": false,
// "num_logins": 0,
// "organization": "first company",
// "p_city": "",
// "p_code": "",
// "p_country": "Canada",
// "p_province": "",
// "p_street": "",
// "p_street2": "",
// "pref_email": true,
// "pref_gmail": false,
// "retainer_id": null,
// "role": "client",
// "s_city": "",
// "s_code": "",
// "s_country": "",
// "s_province": "",
// "s_street": "",
// "s_street2": "",
// "signup_date": "2019-04-18 13:38:23",
// "statement_token": null,
// "subdomain": null,
// "updated": "2019-04-29 16:45:55",
// "userid": 31006,
// "username": "clientone",
// "vat_name": null,
// "vat_number": "",
// "vis_state": 0
// }
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var Accounting_systemid: String? = jResp.StringOf("response.result.client.accounting_systemid")
var Allow_late_fees: Bool = jResp.BoolOf("response.result.client.allow_late_fees")
var Allow_late_notifications: Bool = jResp.BoolOf("response.result.client.allow_late_notifications")
var Bus_phone: String? = jResp.StringOf("response.result.client.bus_phone")
var Company_industry: String? = jResp.StringOf("response.result.client.company_industry")
var Company_size: String? = jResp.StringOf("response.result.client.company_size")
var Currency_code: String? = jResp.StringOf("response.result.client.currency_code")
var Direct_link_token: String? = jResp.StringOf("response.result.client.direct_link_token")
var v_Email: String? = jResp.StringOf("response.result.client.email")
var Fax: String? = jResp.StringOf("response.result.client.fax")
var Fname: String? = jResp.StringOf("response.result.client.fname")
var Has_retainer: String? = jResp.StringOf("response.result.client.has_retainer")
var Home_phone: String? = jResp.StringOf("response.result.client.home_phone")
var Id: Int = jResp.IntOf("response.result.client.id").intValue
var Language: String? = jResp.StringOf("response.result.client.language")
var Last_activity: String? = jResp.StringOf("response.result.client.last_activity")
var Last_login: String? = jResp.StringOf("response.result.client.last_login")
var Level: Int = jResp.IntOf("response.result.client.level").intValue
var Lname: String? = jResp.StringOf("response.result.client.lname")
var Mob_phone: String? = jResp.StringOf("response.result.client.mob_phone")
var Note: String? = jResp.StringOf("response.result.client.note")
var Notified: Bool = jResp.BoolOf("response.result.client.notified")
var Num_logins: Int = jResp.IntOf("response.result.client.num_logins").intValue
var Organization: String? = jResp.StringOf("response.result.client.organization")
var P_city: String? = jResp.StringOf("response.result.client.p_city")
var P_code: String? = jResp.StringOf("response.result.client.p_code")
var P_country: String? = jResp.StringOf("response.result.client.p_country")
var P_province: String? = jResp.StringOf("response.result.client.p_province")
var P_street: String? = jResp.StringOf("response.result.client.p_street")
var P_street2: String? = jResp.StringOf("response.result.client.p_street2")
var Pref_email: Bool = jResp.BoolOf("response.result.client.pref_email")
var Pref_gmail: Bool = jResp.BoolOf("response.result.client.pref_gmail")
var Retainer_id: String? = jResp.StringOf("response.result.client.retainer_id")
var Role: String? = jResp.StringOf("response.result.client.role")
var S_city: String? = jResp.StringOf("response.result.client.s_city")
var S_code: String? = jResp.StringOf("response.result.client.s_code")
var S_country: String? = jResp.StringOf("response.result.client.s_country")
var S_province: String? = jResp.StringOf("response.result.client.s_province")
var S_street: String? = jResp.StringOf("response.result.client.s_street")
var S_street2: String? = jResp.StringOf("response.result.client.s_street2")
var Signup_date: String? = jResp.StringOf("response.result.client.signup_date")
var Statement_token: String? = jResp.StringOf("response.result.client.statement_token")
var Subdomain: String? = jResp.StringOf("response.result.client.subdomain")
var Updated: String? = jResp.StringOf("response.result.client.updated")
var Userid: Int = jResp.IntOf("response.result.client.userid").intValue
var Username: String? = jResp.StringOf("response.result.client.username")
var Vat_name: String? = jResp.StringOf("response.result.client.vat_name")
var Vat_number: String? = jResp.StringOf("response.result.client.vat_number")
var Vis_state: Int = jResp.IntOf("response.result.client.vis_state").intValue
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}
Postman Collection Item JSON
{
"name": "Single Client",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
]
},
"description": "Get a single client with the parameter associated with clientId"
},
"response": [
{
"name": "Single Client Error - Client Not Found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customer_Id}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customer_Id}}"
]
}
},
"status": "NOT FOUND",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sJWQRZBFFcAgVTVVoLBAlcWU4aABtEVVBQVgZVAQZSAQxUWQ1WARFJXwBdElY/"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 17:50:37 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"errors\": [\n {\n \"errno\": 1012,\n \"field\": \"userid\",\n \"message\": \"Client not found.\",\n \"object\": \"client\",\n \"value\": \"{{customer_Id}}\"\n }\n ]\n }\n}"
},
{
"name": "Single Client",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"clients",
"{{customerId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwADlkHVhYaFAQeA0sIVAFTClJQDg5QX1UPBAdXVU4aABtEBQQDVlMCUQcFBloDXQsHChFJXwBdElY/"
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557344346"
},
{
"key": "Retry-After",
"value": "20"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 19:38:45 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"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": "Wed, 08 May 2019 19:38:45 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17330-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 \"result\": {\n \"client\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"allow_late_fees\": true,\n \"allow_late_notifications\": true,\n \"bus_phone\": \"\",\n \"company_industry\": null,\n \"company_size\": null,\n \"currency_code\": \"USD\",\n \"direct_link_token\": null,\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"fname\": \"Nicolas\",\n \"has_retainer\": null,\n \"home_phone\": \"555-555-1234\",\n \"id\": 31006,\n \"language\": \"en\",\n \"last_activity\": null,\n \"last_login\": null,\n \"level\": 0,\n \"lname\": \"one\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"notified\": false,\n \"num_logins\": 0,\n \"organization\": \"first company\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"Canada\",\n \"p_province\": \"\",\n \"p_street\": \"\",\n \"p_street2\": \"\",\n \"pref_email\": true,\n \"pref_gmail\": false,\n \"retainer_id\": null,\n \"role\": \"client\",\n \"s_city\": \"\",\n \"s_code\": \"\",\n \"s_country\": \"\",\n \"s_province\": \"\",\n \"s_street\": \"\",\n \"s_street2\": \"\",\n \"signup_date\": \"2019-04-18 13:38:23\",\n \"statement_token\": null,\n \"subdomain\": null,\n \"updated\": \"2019-04-29 16:45:55\",\n \"userid\": 31006,\n \"username\": \"clientone\",\n \"vat_name\": null,\n \"vat_number\": \"\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
