Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAccounting_systemid
String sApi_token
String sBus_phone
String sCurrency_code
String sDisplay_name
String sV_Email
String sFax
String sFname
String sHome_phone
Integer iId
String sLanguage
String sLast_login
Integer iLevel
String sLname
String sMob_phone
String sNote
Integer iNum_logins
String sOrganization
String sP_city
String sP_code
String sP_country
String sP_province
String sP_street
String sP_street2
String sRate
String sRole
String sSignup_date
String sUpdated
Integer iUserid
String sUsername
Integer iVis_state
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "staff": {
// "fname": "Ryen"
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "staff.fname" "Ryen" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "response": {
// "result": {
// "staff": {
// "accounting_systemid": "wkMd2g",
// "api_token": "9249ac8633763523fe614cdeb28787b9",
// "bus_phone": "",
// "currency_code": null,
// "display_name": "RyenMarr",
// "email": "api.freshbooks@gmail.com",
// "fax": "",
// "fname": "Ryen",
// "home_phone": null,
// "id": 1,
// "language": "en",
// "last_login": null,
// "level": 3,
// "lname": "Marr",
// "mob_phone": "",
// "note": null,
// "num_logins": 0,
// "organization": "Postman Sandbox",
// "p_city": "",
// "p_code": "",
// "p_country": "",
// "p_province": "",
// "p_street": "",
// "p_street2": "",
// "rate": null,
// "role": "admin",
// "signup_date": "2019-04-18 09:14:53",
// "updated": "2019-04-24 14:37:58",
// "userid": 1,
// "username": "rmarr@freshbooks.com",
// "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
Get ComStringOf Of hoJResp "response.result.staff.accounting_systemid" To sAccounting_systemid
Get ComStringOf Of hoJResp "response.result.staff.api_token" To sApi_token
Get ComStringOf Of hoJResp "response.result.staff.bus_phone" To sBus_phone
Get ComStringOf Of hoJResp "response.result.staff.currency_code" To sCurrency_code
Get ComStringOf Of hoJResp "response.result.staff.display_name" To sDisplay_name
Get ComStringOf Of hoJResp "response.result.staff.email" To sV_Email
Get ComStringOf Of hoJResp "response.result.staff.fax" To sFax
Get ComStringOf Of hoJResp "response.result.staff.fname" To sFname
Get ComStringOf Of hoJResp "response.result.staff.home_phone" To sHome_phone
Get ComIntOf Of hoJResp "response.result.staff.id" To iId
Get ComStringOf Of hoJResp "response.result.staff.language" To sLanguage
Get ComStringOf Of hoJResp "response.result.staff.last_login" To sLast_login
Get ComIntOf Of hoJResp "response.result.staff.level" To iLevel
Get ComStringOf Of hoJResp "response.result.staff.lname" To sLname
Get ComStringOf Of hoJResp "response.result.staff.mob_phone" To sMob_phone
Get ComStringOf Of hoJResp "response.result.staff.note" To sNote
Get ComIntOf Of hoJResp "response.result.staff.num_logins" To iNum_logins
Get ComStringOf Of hoJResp "response.result.staff.organization" To sOrganization
Get ComStringOf Of hoJResp "response.result.staff.p_city" To sP_city
Get ComStringOf Of hoJResp "response.result.staff.p_code" To sP_code
Get ComStringOf Of hoJResp "response.result.staff.p_country" To sP_country
Get ComStringOf Of hoJResp "response.result.staff.p_province" To sP_province
Get ComStringOf Of hoJResp "response.result.staff.p_street" To sP_street
Get ComStringOf Of hoJResp "response.result.staff.p_street2" To sP_street2
Get ComStringOf Of hoJResp "response.result.staff.rate" To sRate
Get ComStringOf Of hoJResp "response.result.staff.role" To sRole
Get ComStringOf Of hoJResp "response.result.staff.signup_date" To sSignup_date
Get ComStringOf Of hoJResp "response.result.staff.updated" To sUpdated
Get ComIntOf Of hoJResp "response.result.staff.userid" To iUserid
Get ComStringOf Of hoJResp "response.result.staff.username" To sUsername
Get ComIntOf Of hoJResp "response.result.staff.vis_state" To iVis_state
End_Procedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"staff": {
"fname": "Ryen"
}
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}
Postman Collection Item JSON
{
"name": "Update Staff",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"staff\": {\n \"fname\": \"Ryen\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"staffs",
"{{staffId}}"
]
}
},
"response": [
{
"name": "Update Staff",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"staff\": {\n \"fname\": \"Ryen\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"users",
"staffs",
"{{staffId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwQFlEEXkAUCBgCHVQMVQlUBFNRDgFXVlsACwZTTVYHHRVRUAAPUVNUWwACAQ9TDgwCEB8DWA1CBG4="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:37:58 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, 24 Apr 2019 18:37:58 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 \"result\": {\n \"staff\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"api_token\": \"9249ac8633763523fe614cdeb28787b9\",\n \"bus_phone\": \"\",\n \"currency_code\": null,\n \"display_name\": \"RyenMarr\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"fax\": \"\",\n \"fname\": \"Ryen\",\n \"home_phone\": null,\n \"id\": 1,\n \"language\": \"en\",\n \"last_login\": null,\n \"level\": 3,\n \"lname\": \"Marr\",\n \"mob_phone\": \"\",\n \"note\": null,\n \"num_logins\": 0,\n \"organization\": \"Postman Sandbox\",\n \"p_city\": \"\",\n \"p_code\": \"\",\n \"p_country\": \"\",\n \"p_province\": \"\",\n \"p_street\": \"\",\n \"p_street2\": \"\",\n \"rate\": null,\n \"role\": \"admin\",\n \"signup_date\": \"2019-04-18 09:14:53\",\n \"updated\": \"2019-04-24 14:37:58\",\n \"userid\": 1,\n \"username\": \"rmarr@freshbooks.com\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
