Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
' 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"
' }
' }
Dim json As New Chilkat.JsonObject
json.UpdateString("staff.fname","Ryen")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")
Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)
Dim resp As Chilkat.HttpResponse = http.PTextSb("PUT","https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' 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
Dim Accounting_systemid As String = jResp.StringOf("response.result.staff.accounting_systemid")
Dim Api_token As String = jResp.StringOf("response.result.staff.api_token")
Dim Bus_phone As String = jResp.StringOf("response.result.staff.bus_phone")
Dim Currency_code As String = jResp.StringOf("response.result.staff.currency_code")
Dim Display_name As String = jResp.StringOf("response.result.staff.display_name")
Dim v_Email As String = jResp.StringOf("response.result.staff.email")
Dim Fax As String = jResp.StringOf("response.result.staff.fax")
Dim Fname As String = jResp.StringOf("response.result.staff.fname")
Dim Home_phone As String = jResp.StringOf("response.result.staff.home_phone")
Dim Id As Integer = jResp.IntOf("response.result.staff.id")
Dim Language As String = jResp.StringOf("response.result.staff.language")
Dim Last_login As String = jResp.StringOf("response.result.staff.last_login")
Dim Level As Integer = jResp.IntOf("response.result.staff.level")
Dim Lname As String = jResp.StringOf("response.result.staff.lname")
Dim Mob_phone As String = jResp.StringOf("response.result.staff.mob_phone")
Dim Note As String = jResp.StringOf("response.result.staff.note")
Dim Num_logins As Integer = jResp.IntOf("response.result.staff.num_logins")
Dim Organization As String = jResp.StringOf("response.result.staff.organization")
Dim P_city As String = jResp.StringOf("response.result.staff.p_city")
Dim P_code As String = jResp.StringOf("response.result.staff.p_code")
Dim P_country As String = jResp.StringOf("response.result.staff.p_country")
Dim P_province As String = jResp.StringOf("response.result.staff.p_province")
Dim P_street As String = jResp.StringOf("response.result.staff.p_street")
Dim P_street2 As String = jResp.StringOf("response.result.staff.p_street2")
Dim Rate As String = jResp.StringOf("response.result.staff.rate")
Dim Role As String = jResp.StringOf("response.result.staff.role")
Dim Signup_date As String = jResp.StringOf("response.result.staff.signup_date")
Dim Updated As String = jResp.StringOf("response.result.staff.updated")
Dim Userid As Integer = jResp.IntOf("response.result.staff.userid")
Dim Username As String = jResp.StringOf("response.result.staff.username")
Dim Vis_state As Integer = jResp.IntOf("response.result.staff.vis_state")
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}"
}
]
}
