Chilkat Online Tools

PureBasic / New FreshBooks / Single Staff

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/staffs/{{staffId}}",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": {
    ;       "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

    Accounting_systemid.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.accounting_systemid")
    Api_token.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.api_token")
    Bus_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.bus_phone")
    Currency_code.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.currency_code")
    Display_name.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.display_name")
    v_Email.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.email")
    Fax.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.fax")
    Fname.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.fname")
    Home_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.home_phone")
    Id.i = CkJsonObject::ckIntOf(jResp,"response.result.staff.id")
    Language.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.language")
    Last_login.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.last_login")
    Level.i = CkJsonObject::ckIntOf(jResp,"response.result.staff.level")
    Lname.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.lname")
    Mob_phone.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.mob_phone")
    Note.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.note")
    Num_logins.i = CkJsonObject::ckIntOf(jResp,"response.result.staff.num_logins")
    Organization.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.organization")
    P_city.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_city")
    P_code.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_code")
    P_country.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_country")
    P_province.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_province")
    P_street.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_street")
    P_street2.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.p_street2")
    Rate.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.rate")
    Role.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.role")
    Signup_date.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.signup_date")
    Updated.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.updated")
    Userid.i = CkJsonObject::ckIntOf(jResp,"response.result.staff.userid")
    Username.s = CkJsonObject::ckStringOf(jResp,"response.result.staff.username")
    Vis_state.i = CkJsonObject::ckIntOf(jResp,"response.result.staff.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/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}"
    }
  ]
}