Chilkat Online Tools

PureBasic / New FreshBooks / Service Rates

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>")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://api.freshbooks.com/comments/business/{{businessId}}/service_rates",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)

    ; {
    ;   "service_rates": [
    ;     {
    ;       "rate": "0.00",
    ;       "service_id": 3575792,
    ;       "business_id": 1966214
    ;     },
    ;     {
    ;       "rate": "45.00",
    ;       "service_id": 3595146,
    ;       "business_id": 1966214
    ;     },
    ;     {
    ;       "rate": "45.00",
    ;       "service_id": 3595148,
    ;       "business_id": 1966214
    ;     },
    ;     {
    ;       "rate": "1000.00",
    ;       "service_id": 3595152,
    ;       "business_id": 1966214
    ;     },
    ;     {
    ;       "rate": "1000.00",
    ;       "service_id": 3600268,
    ;       "business_id": 1966214
    ;     }
    ;   ]
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    rate.s
    service_id.i
    business_id.i

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"service_rates")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        rate = CkJsonObject::ckStringOf(jResp,"service_rates[i].rate")
        service_id = CkJsonObject::ckIntOf(jResp,"service_rates[i].service_id")
        business_id = CkJsonObject::ckIntOf(jResp,"service_rates[i].business_id")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/comments/business/{{businessId}}/service_rates

Postman Collection Item JSON

{
  "name": "Service Rates",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/service_rates",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "comments",
        "business",
        "{{businessId}}",
        "service_rates"
      ]
    },
    "description": "Get all service rates associated with this project\t"
  },
  "response": [
    {
      "name": "Service Rates",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/comments/business/{{businessId}}/service_rates",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "comments",
            "business",
            "{{businessId}}",
            "service_rates"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "nginx"
        },
        {
          "key": "Content-Type",
          "value": "application/vnd.api+json"
        },
        {
          "key": "X-Version",
          "value": "1904.25.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEVUQTgtbXWtAUhFcEh8TVhELQ0UCA1lLVkISCAFSbkUHEFRFEU5WT1IeUwpUCAAHAQRRCVMCVQBVURoaUEpBXgIHBlFWVVAAAgcHAQFVA0FOVgNUEV1l"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Wed, 25 Apr 2018 17:24:51 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "Via",
          "value": "1.1 google"
        },
        {
          "key": "Via",
          "value": "1.1 varnish"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Accept-Ranges",
          "value": "bytes"
        },
        {
          "key": "Content-Length",
          "value": "352"
        },
        {
          "key": "Date",
          "value": "Thu, 25 Apr 2019 17:24:51 GMT"
        },
        {
          "key": "Age",
          "value": "0"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "X-Served-By",
          "value": "cache-mdw17341-MDW"
        },
        {
          "key": "X-Cache",
          "value": "MISS"
        },
        {
          "key": "X-Cache-Hits",
          "value": "0"
        },
        {
          "key": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"service_rates\": [\n        {\n            \"rate\": \"0.00\",\n            \"service_id\": 3575792,\n            \"business_id\": 1966214\n        },\n        {\n            \"rate\": \"45.00\",\n            \"service_id\": 3595146,\n            \"business_id\": 1966214\n        },\n        {\n            \"rate\": \"45.00\",\n            \"service_id\": 3595148,\n            \"business_id\": 1966214\n        },\n        {\n            \"rate\": \"1000.00\",\n            \"service_id\": 3595152,\n            \"business_id\": 1966214\n        },\n        {\n            \"rate\": \"1000.00\",\n            \"service_id\": 3600268,\n            \"business_id\": 1966214\n        }\n    ]\n}"
    }
  ]
}