Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.freshbooks.com/accounting/account/{{accountId}}/users/clients/{{customerId}}",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
Accounting_systemid.s = CkJsonObject::ckStringOf(jResp,"response.result.client.accounting_systemid")
Allow_late_fees.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.allow_late_fees")
Allow_late_notifications.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.allow_late_notifications")
Bus_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.bus_phone")
Company_industry.s = CkJsonObject::ckStringOf(jResp,"response.result.client.company_industry")
Company_size.s = CkJsonObject::ckStringOf(jResp,"response.result.client.company_size")
Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.currency_code")
Direct_link_token.s = CkJsonObject::ckStringOf(jResp,"response.result.client.direct_link_token")
v_Email.s = CkJsonObject::ckStringOf(jResp,"response.result.client.email")
Fax.s = CkJsonObject::ckStringOf(jResp,"response.result.client.fax")
Fname.s = CkJsonObject::ckStringOf(jResp,"response.result.client.fname")
Has_retainer.s = CkJsonObject::ckStringOf(jResp,"response.result.client.has_retainer")
Home_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.home_phone")
Id.i = CkJsonObject::ckIntOf(jResp,"response.result.client.id")
Language.s = CkJsonObject::ckStringOf(jResp,"response.result.client.language")
Last_activity.s = CkJsonObject::ckStringOf(jResp,"response.result.client.last_activity")
Last_login.s = CkJsonObject::ckStringOf(jResp,"response.result.client.last_login")
Level.i = CkJsonObject::ckIntOf(jResp,"response.result.client.level")
Lname.s = CkJsonObject::ckStringOf(jResp,"response.result.client.lname")
Mob_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.client.mob_phone")
Note.s = CkJsonObject::ckStringOf(jResp,"response.result.client.note")
Notified.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.notified")
Num_logins.i = CkJsonObject::ckIntOf(jResp,"response.result.client.num_logins")
Organization.s = CkJsonObject::ckStringOf(jResp,"response.result.client.organization")
P_city.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_city")
P_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_code")
P_country.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_country")
P_province.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_province")
P_street.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_street")
P_street2.s = CkJsonObject::ckStringOf(jResp,"response.result.client.p_street2")
Pref_email.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.pref_email")
Pref_gmail.i = CkJsonObject::ckBoolOf(jResp,"response.result.client.pref_gmail")
Retainer_id.s = CkJsonObject::ckStringOf(jResp,"response.result.client.retainer_id")
Role.s = CkJsonObject::ckStringOf(jResp,"response.result.client.role")
S_city.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_city")
S_code.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_code")
S_country.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_country")
S_province.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_province")
S_street.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_street")
S_street2.s = CkJsonObject::ckStringOf(jResp,"response.result.client.s_street2")
Signup_date.s = CkJsonObject::ckStringOf(jResp,"response.result.client.signup_date")
Statement_token.s = CkJsonObject::ckStringOf(jResp,"response.result.client.statement_token")
Subdomain.s = CkJsonObject::ckStringOf(jResp,"response.result.client.subdomain")
Updated.s = CkJsonObject::ckStringOf(jResp,"response.result.client.updated")
Userid.i = CkJsonObject::ckIntOf(jResp,"response.result.client.userid")
Username.s = CkJsonObject::ckStringOf(jResp,"response.result.client.username")
Vat_name.s = CkJsonObject::ckStringOf(jResp,"response.result.client.vat_name")
Vat_number.s = CkJsonObject::ckStringOf(jResp,"response.result.client.vat_number")
Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.client.vis_state")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
