PowerBuilder / New FreshBooks / Single Staff
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Accounting_systemid
string ls_Api_token
string ls_Bus_phone
string ls_Currency_code
string ls_Display_name
string ls_V_Email
string ls_Fax
string ls_Fname
string ls_Home_phone
integer li_Id
string ls_Language
string ls_Last_login
integer li_Level
string ls_Lname
string ls_Mob_phone
string ls_Note
integer li_Num_logins
string ls_Organization
string ls_P_city
string ls_P_code
string ls_P_country
string ls_P_province
string ls_P_street
string ls_P_street2
string ls_Rate
string ls_Role
string ls_Signup_date
string ls_Updated
integer li_Userid
string ls_Username
integer li_Vis_state
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
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": "api.freshbooks@gmail.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
ls_Accounting_systemid = loo_JResp.StringOf("response.result.staff.accounting_systemid")
ls_Api_token = loo_JResp.StringOf("response.result.staff.api_token")
ls_Bus_phone = loo_JResp.StringOf("response.result.staff.bus_phone")
ls_Currency_code = loo_JResp.StringOf("response.result.staff.currency_code")
ls_Display_name = loo_JResp.StringOf("response.result.staff.display_name")
ls_V_Email = loo_JResp.StringOf("response.result.staff.email")
ls_Fax = loo_JResp.StringOf("response.result.staff.fax")
ls_Fname = loo_JResp.StringOf("response.result.staff.fname")
ls_Home_phone = loo_JResp.StringOf("response.result.staff.home_phone")
li_Id = loo_JResp.IntOf("response.result.staff.id")
ls_Language = loo_JResp.StringOf("response.result.staff.language")
ls_Last_login = loo_JResp.StringOf("response.result.staff.last_login")
li_Level = loo_JResp.IntOf("response.result.staff.level")
ls_Lname = loo_JResp.StringOf("response.result.staff.lname")
ls_Mob_phone = loo_JResp.StringOf("response.result.staff.mob_phone")
ls_Note = loo_JResp.StringOf("response.result.staff.note")
li_Num_logins = loo_JResp.IntOf("response.result.staff.num_logins")
ls_Organization = loo_JResp.StringOf("response.result.staff.organization")
ls_P_city = loo_JResp.StringOf("response.result.staff.p_city")
ls_P_code = loo_JResp.StringOf("response.result.staff.p_code")
ls_P_country = loo_JResp.StringOf("response.result.staff.p_country")
ls_P_province = loo_JResp.StringOf("response.result.staff.p_province")
ls_P_street = loo_JResp.StringOf("response.result.staff.p_street")
ls_P_street2 = loo_JResp.StringOf("response.result.staff.p_street2")
ls_Rate = loo_JResp.StringOf("response.result.staff.rate")
ls_Role = loo_JResp.StringOf("response.result.staff.role")
ls_Signup_date = loo_JResp.StringOf("response.result.staff.signup_date")
ls_Updated = loo_JResp.StringOf("response.result.staff.updated")
li_Userid = loo_JResp.IntOf("response.result.staff.userid")
ls_Username = loo_JResp.StringOf("response.result.staff.username")
li_Vis_state = loo_JResp.IntOf("response.result.staff.vis_state")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/users/staffs/{{staffId}}
Postman Collection Item JSON
{
"name": "Single Staff",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"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": "Single Staff",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"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": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gRQlNBEVwQFlEEXkAUCBgCHVQOVQBUAlpdAQNSVlcJCglWTU8GHRUEUFIGUAEAAVJRBgpaXFxQEB8DWA1CBG4="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557346267"
},
{
"key": "Retry-After",
"value": "54"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:10:12 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": "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, 08 May 2019 20:10:12 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17361-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\": \"api.freshbooks@gmail.com\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
