SQL Server / New FreshBooks / Single Project
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @business_id int
DECLARE @id int
DECLARE @name nvarchar(4000)
DECLARE @billable int
DECLARE @vis_state int
DECLARE @identity_id int
DECLARE @role nvarchar(4000)
DECLARE @first_name nvarchar(4000)
DECLARE @last_name nvarchar(4000)
DECLARE @email nvarchar(4000)
DECLARE @company nvarchar(4000)
DECLARE @active int
DECLARE @value int
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'project.id'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'project.title'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'project.description'
DECLARE @Due_date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Due_date OUT, 'project.due_date'
DECLARE @Client_id int
EXEC sp_OAMethod @jResp, 'IntOf', @Client_id OUT, 'project.client_id'
DECLARE @Internal int
EXEC sp_OAMethod @jResp, 'BoolOf', @Internal OUT, 'project.internal'
DECLARE @Budget nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Budget OUT, 'project.budget'
DECLARE @Fixed_price nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Fixed_price OUT, 'project.fixed_price'
DECLARE @Rate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Rate OUT, 'project.rate'
DECLARE @Billing_method nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Billing_method OUT, 'project.billing_method'
DECLARE @Project_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Project_type OUT, 'project.project_type'
DECLARE @Active int
EXEC sp_OAMethod @jResp, 'BoolOf', @Active OUT, 'project.active'
DECLARE @Complete int
EXEC sp_OAMethod @jResp, 'BoolOf', @Complete OUT, 'project.complete'
DECLARE @Sample int
EXEC sp_OAMethod @jResp, 'BoolOf', @Sample OUT, 'project.sample'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'project.created_at'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'project.updated_at'
DECLARE @Logged_duration nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Logged_duration OUT, 'project.logged_duration'
DECLARE @Billed_amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Billed_amount OUT, 'project.billed_amount'
DECLARE @Billed_status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Billed_status OUT, 'project.billed_status'
DECLARE @Retainer_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Retainer_id OUT, 'project.retainer_id'
DECLARE @GroupId int
EXEC sp_OAMethod @jResp, 'IntOf', @GroupId OUT, 'project.group.id'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'project.services'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @business_id OUT, 'project.services[i].business_id'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'project.services[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'project.services[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @billable OUT, 'project.services[i].billable'
EXEC sp_OAMethod @jResp, 'IntOf', @vis_state OUT, 'project.services[i].vis_state'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'project.group.members'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'project.group.members[i].id'
EXEC sp_OAMethod @jResp, 'IntOf', @identity_id OUT, 'project.group.members[i].identity_id'
EXEC sp_OAMethod @jResp, 'StringOf', @role OUT, 'project.group.members[i].role'
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'project.group.members[i].first_name'
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'project.group.members[i].last_name'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'project.group.members[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @company OUT, 'project.group.members[i].company'
EXEC sp_OAMethod @jResp, 'BoolOf', @active OUT, 'project.group.members[i].active'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'project.group.pending_invitations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'abilities'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'abilities[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @value OUT, 'abilities[i].value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
