delphiAx / New FreshBooks / Create Single Project
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: Integer;
identity_id: Integer;
role: WideString;
first_name: WideString;
last_name: WideString;
email: WideString;
company: WideString;
active: 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;
Retainer_id: WideString;
GroupId: Integer;
Pending_invitations: WideString;
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);
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "project": {
// "title": "Titikaka Hiking Guide",
// "client_id": 123,
// "project_type": "fixed_price",
// "fixed_price": "3000",
// "due_date": "2019-04-18",
// "services": [
// {
// "id": 123,
// "billable": true,
// "vis_state": 0
// },
// {
// "id": 123,
// "billable": true,
// "vis_state": 0
// },
// {
// "id": 123,
// "billable": true,
// "vis_state": 0
// },
// {
// "id": 123,
// "billable": true,
// "vis_state": 0
// }
// ]
// }
// }
json := TChilkatJsonObject.Create(Self);
json.UpdateString('project.title','Titikaka Hiking Guide');
json.UpdateInt('project.client_id',123);
json.UpdateString('project.project_type','fixed_price');
json.UpdateString('project.fixed_price','3000');
json.UpdateString('project.due_date','2019-04-18');
json.UpdateInt('project.services[0].id',123);
json.UpdateBool('project.services[0].billable',1);
json.UpdateInt('project.services[0].vis_state',0);
json.UpdateInt('project.services[1].id',123);
json.UpdateBool('project.services[1].billable',1);
json.UpdateInt('project.services[1].vis_state',0);
json.UpdateInt('project.services[2].id',123);
json.UpdateBool('project.services[2].billable',1);
json.UpdateInt('project.services[2].vis_state',0);
json.UpdateInt('project.services[3].id',123);
json.UpdateBool('project.services[3].billable',1);
json.UpdateInt('project.services[3].vis_state',0);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
http.SetRequestHeader('Content-Type','application/json');
resp := http.PostJson3('https://api.freshbooks.com/projects/business/{{businessId}}/projects','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "project": {
// "id": 3018266,
// "title": "Titikaka Hiking Guide",
// "description": null,
// "due_date": "2019-04-18",
// "client_id": 31006,
// "internal": false,
// "budget": null,
// "fixed_price": "3000.00",
// "rate": null,
// "billing_method": null,
// "project_type": "fixed_price",
// "active": true,
// "complete": false,
// "sample": false,
// "created_at": "2019-05-08T20:06:55",
// "updated_at": "2019-05-08T20:06:55",
// "logged_duration": null,
// "services": [
// ],
// "billed_amount": "0.00",
// "billed_status": "unbilled",
// "retainer_id": null,
// "group": {
// "id": 5049390,
// "members": [
// {
// "id": 6578346,
// "identity_id": 37256,
// "role": "owner",
// "first_name": "Marshall",
// "last_name": "Johnston",
// "email": "api.freshbooks@freshbooks.com",
// "company": "Postman Sandbox",
// "active": true
// }
// ],
// "pending_invitations": null
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id := jResp.IntOf('project.id');
Title := jResp.StringOf('project.title');
Description := jResp.StringOf('project.description');
Due_date := jResp.StringOf('project.due_date');
Client_id := jResp.IntOf('project.client_id');
Internal := jResp.BoolOf('project.internal');
Budget := jResp.StringOf('project.budget');
Fixed_price := jResp.StringOf('project.fixed_price');
Rate := jResp.StringOf('project.rate');
Billing_method := jResp.StringOf('project.billing_method');
Project_type := jResp.StringOf('project.project_type');
Active := jResp.BoolOf('project.active');
Complete := jResp.BoolOf('project.complete');
Sample := jResp.BoolOf('project.sample');
Created_at := jResp.StringOf('project.created_at');
Updated_at := jResp.StringOf('project.updated_at');
Logged_duration := jResp.StringOf('project.logged_duration');
Billed_amount := jResp.StringOf('project.billed_amount');
Billed_status := jResp.StringOf('project.billed_status');
Retainer_id := jResp.StringOf('project.retainer_id');
GroupId := jResp.IntOf('project.group.id');
Pending_invitations := jResp.StringOf('project.group.pending_invitations');
i := 0;
count_i := jResp.SizeOfArray('project.services');
while i < count_i do
begin
jResp.I := i;
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('project.group.members');
while i < count_i do
begin
jResp.I := i;
id := jResp.IntOf('project.group.members[i].id');
identity_id := jResp.IntOf('project.group.members[i].identity_id');
role := jResp.StringOf('project.group.members[i].role');
first_name := jResp.StringOf('project.group.members[i].first_name');
last_name := jResp.StringOf('project.group.members[i].last_name');
email := jResp.StringOf('project.group.members[i].email');
company := jResp.StringOf('project.group.members[i].company');
active := jResp.BoolOf('project.group.members[i].active');
i := i + 1;
end;
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"project": {
"title": "Titikaka Hiking Guide",
"client_id": {{customerId}},
"project_type": "fixed_price",
"fixed_price": "3000",
"due_date": "2019-04-18",
"services":
[
{"id": {{serviceid}}, "billable": true, "vis_state": 0}, {"id": {{serviceid}},"billable": true, "vis_state": 0}, {"id": {{serviceid}}, "billable": true, "vis_state": 0}, {"id": {{serviceid}}, "billable": true, "vis_state": 0}
]
}
}'
https://api.freshbooks.com/projects/business/{{businessId}}/projects
Postman Collection Item JSON
{
"name": "Create Single Project",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"projectId\", jsonData.project.id);",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"project\": {\n \"title\": \"Titikaka Hiking Guide\",\n \"client_id\": {{customerId}},\n \"project_type\": \"fixed_price\",\n \"fixed_price\": \"3000\",\n \"due_date\": \"2019-04-18\",\n \"services\": \n [\n \t{\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}},\"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}, {\"id\": {{serviceid}}, \"billable\": true, \"vis_state\": 0}\n \t]\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects"
]
}
},
"response": [
{
"name": "Create Single Project",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"project\": {\n \"title\": \"Titikaka Hiking Guide\",\n \"client_id\": {{customerId}},\n \"project_type\": \"fixed_price\",\n \"fixed_price\": \"3000\",\n \"due_date\": \"2019-04-18\"\n }\n}"
},
"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": "1905.7.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTEccQQBKDkQTUAdeRkUODAZbR0NGTVIbARlUVAcEB1VTVVoBUQhWAQsFBB9UDlQdQ1dSVVBSBFFRD1dVVldVAAIVSgJQWkAHOw=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "8"
},
{
"key": "X-RateLimit-Reset",
"value": "1557346076"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:06:55 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Content-Length",
"value": "759"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 20:06:55 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": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"project\": {\n \"id\": 3018266,\n \"title\": \"Titikaka Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-04-18\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"3000.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-05-08T20:06:55\",\n \"updated_at\": \"2019-05-08T20:06:55\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"retainer_id\": null,\n \"group\": {\n \"id\": 5049390,\n \"members\": [\n {\n \"id\": 6578346,\n \"identity_id\": 37256,\n \"role\": \"owner\",\n \"first_name\": \"Marshall\",\n \"last_name\": \"Johnston\",\n \"email\": \"api.freshbooks@freshbooks.com\",\n \"company\": \"Postman Sandbox\",\n \"active\": true\n }\n ],\n \"pending_invitations\": null\n }\n }\n}"
}
]
}
