PureBasic / New FreshBooks / Single Project
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/projects/business/{{businessId}}/projects/{{projectId}}",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)
; {
; "project": {
; "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",
; "retainer_id": null,
; "group": {
; "id": 4942784,
; "members": [
; {
; "id": 6446258,
; "identity_id": 1882548,
; "role": "owner",
; "first_name": "Ryan",
; "last_name": "Marr",
; "email": "api.freshbooks@freshbooks.com",
; "company": "Postman Sandbox",
; "active": true
; }
; ],
; "pending_invitations": [
; ]
; }
; },
; "abilities": [
; {
; "name": "can_edit",
; "value": true
; },
; {
; "name": "can_archive",
; "value": true
; },
; {
; "name": "can_generate_invoice",
; "value": true
; },
; {
; "name": "can_delete",
; "value": true
; },
; {
; "name": "can_invite_team_member",
; "value": true
; },
; {
; "name": "can_manage_services",
; "value": true
; },
; {
; "name": "can_edit_hourly_budget",
; "value": true
; },
; {
; "name": "can_view_fixed_price",
; "value": true
; },
; {
; "name": "can_edit_fixed_price",
; "value": true
; },
; {
; "name": "can_edit_end_date",
; "value": true
; },
; {
; "name": "can_edit_flat_rate",
; "value": true
; },
; {
; "name": "can_edit_project_type",
; "value": true
; },
; {
; "name": "can_edit_title",
; "value": true
; },
; {
; "name": "can_view_review_tab",
; "value": true
; },
; {
; "name": "can_view_discuss_tab",
; "value": false
; },
; {
; "name": "can_track_time",
; "value": true
; },
; {
; "name": "can_create_comment",
; "value": true
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
business_id.i
id.i
name.s
billable.i
vis_state.i
identity_id.i
role.s
first_name.s
last_name.s
email.s
company.s
active.i
value.i
Id.i = CkJsonObject::ckIntOf(jResp,"project.id")
Title.s = CkJsonObject::ckStringOf(jResp,"project.title")
Description.s = CkJsonObject::ckStringOf(jResp,"project.description")
Due_date.s = CkJsonObject::ckStringOf(jResp,"project.due_date")
Client_id.i = CkJsonObject::ckIntOf(jResp,"project.client_id")
Internal.i = CkJsonObject::ckBoolOf(jResp,"project.internal")
Budget.s = CkJsonObject::ckStringOf(jResp,"project.budget")
Fixed_price.s = CkJsonObject::ckStringOf(jResp,"project.fixed_price")
Rate.s = CkJsonObject::ckStringOf(jResp,"project.rate")
Billing_method.s = CkJsonObject::ckStringOf(jResp,"project.billing_method")
Project_type.s = CkJsonObject::ckStringOf(jResp,"project.project_type")
Active.i = CkJsonObject::ckBoolOf(jResp,"project.active")
Complete.i = CkJsonObject::ckBoolOf(jResp,"project.complete")
Sample.i = CkJsonObject::ckBoolOf(jResp,"project.sample")
Created_at.s = CkJsonObject::ckStringOf(jResp,"project.created_at")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"project.updated_at")
Logged_duration.s = CkJsonObject::ckStringOf(jResp,"project.logged_duration")
Billed_amount.s = CkJsonObject::ckStringOf(jResp,"project.billed_amount")
Billed_status.s = CkJsonObject::ckStringOf(jResp,"project.billed_status")
Retainer_id.s = CkJsonObject::ckStringOf(jResp,"project.retainer_id")
GroupId.i = CkJsonObject::ckIntOf(jResp,"project.group.id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"project.services")
While i < count_i
CkJsonObject::setCkI(jResp, i)
business_id = CkJsonObject::ckIntOf(jResp,"project.services[i].business_id")
id = CkJsonObject::ckIntOf(jResp,"project.services[i].id")
name = CkJsonObject::ckStringOf(jResp,"project.services[i].name")
billable = CkJsonObject::ckBoolOf(jResp,"project.services[i].billable")
vis_state = CkJsonObject::ckIntOf(jResp,"project.services[i].vis_state")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"project.group.members")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckIntOf(jResp,"project.group.members[i].id")
identity_id = CkJsonObject::ckIntOf(jResp,"project.group.members[i].identity_id")
role = CkJsonObject::ckStringOf(jResp,"project.group.members[i].role")
first_name = CkJsonObject::ckStringOf(jResp,"project.group.members[i].first_name")
last_name = CkJsonObject::ckStringOf(jResp,"project.group.members[i].last_name")
email = CkJsonObject::ckStringOf(jResp,"project.group.members[i].email")
company = CkJsonObject::ckStringOf(jResp,"project.group.members[i].company")
active = CkJsonObject::ckBoolOf(jResp,"project.group.members[i].active")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"project.group.pending_invitations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"abilities")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"abilities[i].name")
value = CkJsonObject::ckBoolOf(jResp,"abilities[i].value")
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/projects/business/{{businessId}}/projects/{{projectId}}
Postman Collection Item JSON
{
"name": "Single Project",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
}
},
"response": [
{
"name": "Single Project",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
}
},
"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": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTBpAVhZWFEMCVlgURFgLAwBMERxUTVIZAAFUXAIBBFZVVFcJUw1XCg8YHwJJG1hUUABaBwcHVFMFDVEEUFVAG1dWChdUaw=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "14"
},
{
"key": "X-RateLimit-Reset",
"value": "1557345999"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:05:38 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": "1653"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 20:05:38 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\": 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 \"retainer_id\": null,\n \"group\": {\n \"id\": 4942784,\n \"members\": [\n {\n \"id\": 6446258,\n \"identity_id\": 1882548,\n \"role\": \"owner\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Marr\",\n \"email\": \"api.freshbooks@freshbooks.com\",\n \"company\": \"Postman Sandbox\",\n \"active\": true\n }\n ],\n \"pending_invitations\": []\n }\n },\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_archive\",\n \"value\": true\n },\n {\n \"name\": \"can_generate_invoice\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n },\n {\n \"name\": \"can_invite_team_member\",\n \"value\": true\n },\n {\n \"name\": \"can_manage_services\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_hourly_budget\",\n \"value\": true\n },\n {\n \"name\": \"can_view_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_end_date\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_flat_rate\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_project_type\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_title\",\n \"value\": true\n },\n {\n \"name\": \"can_view_review_tab\",\n \"value\": true\n },\n {\n \"name\": \"can_view_discuss_tab\",\n \"value\": false\n },\n {\n \"name\": \"can_track_time\",\n \"value\": true\n },\n {\n \"name\": \"can_create_comment\",\n \"value\": true\n }\n ]\n}"
}
]
}
