Chilkat Online Tools

delphiAx / New FreshBooks / List Projects

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: Integer;
title: WideString;
description: WideString;
due_date: WideString;
client_id: Integer;
internal: Integer;
budget: WideString;
fixed_price: WideString;
rate: WideString;
billing_method: WideString;
project_type: WideString;
active: Integer;
complete: Integer;
sample: Integer;
created_at: WideString;
updated_at: WideString;
logged_duration: WideString;
billed_amount: WideString;
billed_status: WideString;
group_id: Integer;
j: Integer;
count_j: Integer;
business_id: Integer;
name: WideString;
billable: Integer;
vis_state: Integer;
Total: Integer;
Per_page: Integer;
Page: Integer;
Pages: Integer;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := TChilkatHttp.Create(Self);

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.freshbooks.com/projects/business/{{businessId}}/projects',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "meta": {
//     "sort": [
//     ],
//     "total": 5,
//     "per_page": 30,
//     "page": 1,
//     "pages": 1
//   },
//   "projects": [
//     {
//       "id": 2980878,
//       "title": "K2 Hiking Guide",
//       "description": null,
//       "due_date": "2019-04-20",
//       "client_id": 31006,
//       "internal": false,
//       "budget": null,
//       "fixed_price": "2000.00",
//       "rate": null,
//       "billing_method": null,
//       "project_type": "fixed_price",
//       "active": true,
//       "complete": false,
//       "sample": false,
//       "created_at": "2019-04-19T18:25:00",
//       "updated_at": "2019-04-19T19:50:26",
//       "logged_duration": null,
//       "services": [
//       ],
//       "billed_amount": "0.00",
//       "billed_status": "unbilled",
//       "group_id": 4951020
//     },
//     {
//       "id": 2980874,
//       "title": "Applachian Hiking Guide",
//       "description": null,
//       "due_date": "2019-05-20",
//       "client_id": 31006,
//       "internal": false,
//       "budget": null,
//       "fixed_price": "1000.00",
//       "rate": null,
//       "billing_method": null,
//       "project_type": "fixed_price",
//       "active": true,
//       "complete": false,
//       "sample": false,
//       "created_at": "2019-04-19T18:22:43",
//       "updated_at": "2019-04-19T18:22:43",
//       "logged_duration": null,
//       "services": [
//       ],
//       "billed_amount": "0.00",
//       "billed_status": "unbilled",
//       "group_id": 4951012
//     },
//     {
//       "id": 2980872,
//       "title": "Applachian Hiking Guide",
//       "description": null,
//       "due_date": "2019-05-20",
//       "client_id": 31006,
//       "internal": false,
//       "budget": null,
//       "fixed_price": "1000.00",
//       "rate": null,
//       "billing_method": null,
//       "project_type": "fixed_price",
//       "active": true,
//       "complete": false,
//       "sample": false,
//       "created_at": "2019-04-19T18:22:06",
//       "updated_at": "2019-04-19T18:22:06",
//       "logged_duration": null,
//       "services": [
//       ],
//       "billed_amount": "0.00",
//       "billed_status": "unbilled",
//       "group_id": 4951006
//     },
//     {
//       "id": 2980870,
//       "title": "Hiking Guide",
//       "description": null,
//       "due_date": "2019-05-20",
//       "client_id": 31006,
//       "internal": false,
//       "budget": null,
//       "fixed_price": "500.00",
//       "rate": null,
//       "billing_method": null,
//       "project_type": "fixed_price",
//       "active": true,
//       "complete": false,
//       "sample": false,
//       "created_at": "2019-04-19T18:21:11",
//       "updated_at": "2019-04-19T18:21:11",
//       "logged_duration": null,
//       "services": [
//       ],
//       "billed_amount": "0.00",
//       "billed_status": "unbilled",
//       "group_id": 4951004
//     },
//     {
//       "id": 2976412,
//       "title": "Very Custom Computer thing",
//       "description": null,
//       "due_date": null,
//       "client_id": 31006,
//       "internal": false,
//       "budget": null,
//       "fixed_price": null,
//       "rate": null,
//       "billing_method": "project_rate",
//       "project_type": "fixed_price",
//       "active": true,
//       "complete": false,
//       "sample": false,
//       "created_at": "2019-04-18T13:43:31",
//       "updated_at": "2019-04-18T13:43:31",
//       "logged_duration": null,
//       "services": [
//         {
//           "business_id": 1966214,
//           "id": 3575792,
//           "name": "Computer Hardware",
//           "billable": true,
//           "vis_state": 0
//         }
//       ],
//       "billed_amount": "0.00",
//       "billed_status": "unbilled",
//       "group_id": 4942784
//     }
//   ]
// }

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

Total := jResp.IntOf('meta.total');
Per_page := jResp.IntOf('meta.per_page');
Page := jResp.IntOf('meta.page');
Pages := jResp.IntOf('meta.pages');
i := 0;
count_i := jResp.SizeOfArray('meta.sort');
while i < count_i do
  begin
    jResp.I := i;
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('projects');
while i < count_i do
  begin
    jResp.I := i;
    id := jResp.IntOf('projects[i].id');
    title := jResp.StringOf('projects[i].title');
    description := jResp.StringOf('projects[i].description');
    due_date := jResp.StringOf('projects[i].due_date');
    client_id := jResp.IntOf('projects[i].client_id');
    internal := jResp.BoolOf('projects[i].internal');
    budget := jResp.StringOf('projects[i].budget');
    fixed_price := jResp.StringOf('projects[i].fixed_price');
    rate := jResp.StringOf('projects[i].rate');
    billing_method := jResp.StringOf('projects[i].billing_method');
    project_type := jResp.StringOf('projects[i].project_type');
    active := jResp.BoolOf('projects[i].active');
    complete := jResp.BoolOf('projects[i].complete');
    sample := jResp.BoolOf('projects[i].sample');
    created_at := jResp.StringOf('projects[i].created_at');
    updated_at := jResp.StringOf('projects[i].updated_at');
    logged_duration := jResp.StringOf('projects[i].logged_duration');
    billed_amount := jResp.StringOf('projects[i].billed_amount');
    billed_status := jResp.StringOf('projects[i].billed_status');
    group_id := jResp.IntOf('projects[i].group_id');
    j := 0;
    count_j := jResp.SizeOfArray('projects[i].services');
    while j < count_j do
      begin
        jResp.J := j;
        business_id := jResp.IntOf('projects[i].services[j].business_id');
        id := jResp.IntOf('projects[i].services[j].id');
        name := jResp.StringOf('projects[i].services[j].name');
        billable := jResp.BoolOf('projects[i].services[j].billable');
        vis_state := jResp.IntOf('projects[i].services[j].vis_state');
        j := j + 1;
      end;

    i := i + 1;
  end;

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Projects",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "let jsonData = JSON.parse(responseBody);",
          "pm.environment.set(\"projectId\", jsonData.projects[0].id);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "projects",
        "business",
        "{{businessId}}",
        "projects"
      ]
    },
    "description": "Remember to remove `Content-Type` headers when making a GET call on projects and time-tracking."
  },
  "response": [
    {
      "name": "List Projects",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
          "protocol": "https",
          "host": [
            "api",
            "freshbooks",
            "com"
          ],
          "path": [
            "projects",
            "business",
            "{{businessId}}",
            "projects"
          ]
        }
      },
      "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.24.0"
        },
        {
          "key": "X-NewRelic-App-Data",
          "value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTEccQQBKDkQTUAdeRkUODAZbR0NGTVIbARlWUgYBA1FfVVADUA5SDAEMHh5UFUMAVVdUUA9VWAUCD1IIUlhQFR1RBwhCU24="
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "*"
        },
        {
          "key": "Expires",
          "value": "Tue, 24 Apr 2018 18:24:44 GMT"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache"
        },
        {
          "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": "Content-Length",
          "value": "2629"
        },
        {
          "key": "Date",
          "value": "Wed, 24 Apr 2019 18:24:44 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": "Country",
          "value": "CA"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains; preload"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"sort\": [],\n        \"total\": 5,\n        \"per_page\": 30,\n        \"page\": 1,\n        \"pages\": 1\n    },\n    \"projects\": [\n        {\n            \"id\": 2980878,\n            \"title\": \"K2 Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-04-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"2000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:25:00\",\n            \"updated_at\": \"2019-04-19T19:50:26\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951020\n        },\n        {\n            \"id\": 2980874,\n            \"title\": \"Applachian Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"1000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:22:43\",\n            \"updated_at\": \"2019-04-19T18:22:43\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951012\n        },\n        {\n            \"id\": 2980872,\n            \"title\": \"Applachian Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"1000.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:22:06\",\n            \"updated_at\": \"2019-04-19T18:22:06\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951006\n        },\n        {\n            \"id\": 2980870,\n            \"title\": \"Hiking Guide\",\n            \"description\": null,\n            \"due_date\": \"2019-05-20\",\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": \"500.00\",\n            \"rate\": null,\n            \"billing_method\": null,\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-19T18:21:11\",\n            \"updated_at\": \"2019-04-19T18:21:11\",\n            \"logged_duration\": null,\n            \"services\": [],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4951004\n        },\n        {\n            \"id\": 2976412,\n            \"title\": \"Very Custom Computer thing\",\n            \"description\": null,\n            \"due_date\": null,\n            \"client_id\": 31006,\n            \"internal\": false,\n            \"budget\": null,\n            \"fixed_price\": null,\n            \"rate\": null,\n            \"billing_method\": \"project_rate\",\n            \"project_type\": \"fixed_price\",\n            \"active\": true,\n            \"complete\": false,\n            \"sample\": false,\n            \"created_at\": \"2019-04-18T13:43:31\",\n            \"updated_at\": \"2019-04-18T13:43:31\",\n            \"logged_duration\": null,\n            \"services\": [\n                {\n                    \"business_id\": 1966214,\n                    \"id\": 3575792,\n                    \"name\": \"Computer Hardware\",\n                    \"billable\": true,\n                    \"vis_state\": 0\n                }\n            ],\n            \"billed_amount\": \"0.00\",\n            \"billed_status\": \"unbilled\",\n            \"group_id\": 4942784\n        }\n    ]\n}"
    }
  ]
}