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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks', @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
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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)
-- {
-- "response": {
-- "result": {
-- "page": 1,
-- "pages": 1,
-- "per_page": 15,
-- "tasks": [
-- {
-- "billable": true,
-- "description": "",
-- "id": 55226,
-- "name": "Computer Hardware",
-- "rate": {
-- "amount": "0.00",
-- "code": "USD"
-- },
-- "taskid": 55226,
-- "tax1": 0,
-- "tax2": 0,
-- "tdesc": "",
-- "tname": "Computer Hardware",
-- "updated": "2019-04-18 09:14:53",
-- "vis_state": 0
-- },
-- {
-- "billable": true,
-- "description": "Specific consulting services for a specific reason",
-- "id": 70986,
-- "name": "Consulting",
-- "rate": {
-- "amount": "45.00",
-- "code": "USD"
-- },
-- "taskid": 70986,
-- "tax1": 0,
-- "tax2": 0,
-- "tdesc": "Specific consulting services for a specific reason",
-- "tname": "Consulting",
-- "updated": "2019-04-23 14:47:22",
-- "vis_state": 0
-- },
-- {
-- "billable": true,
-- "description": "Specific contracting services for a specific reason",
-- "id": 70988,
-- "name": "Contracting",
-- "rate": {
-- "amount": "45.00",
-- "code": "USD"
-- },
-- "taskid": 70988,
-- "tax1": 0,
-- "tax2": 0,
-- "tdesc": "Specific contracting services for a specific reason",
-- "tname": "Contracting",
-- "updated": "2019-04-23 14:48:11",
-- "vis_state": 0
-- },
-- {
-- "billable": true,
-- "description": "Hourly rate for doing positive things",
-- "id": 70992,
-- "name": "Saving Planet",
-- "rate": {
-- "amount": "1000.00",
-- "code": "USD"
-- },
-- "taskid": 70992,
-- "tax1": 0,
-- "tax2": 0,
-- "tdesc": "Hourly rate for doing positive things",
-- "tname": "Saving Planet",
-- "updated": "2019-04-23 14:50:57",
-- "vis_state": 0
-- }
-- ],
-- "total": 4
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @billable int
DECLARE @description nvarchar(4000)
DECLARE @id int
DECLARE @name nvarchar(4000)
DECLARE @Amount nvarchar(4000)
DECLARE @Code nvarchar(4000)
DECLARE @taskid int
DECLARE @tax1 int
DECLARE @tax2 int
DECLARE @tdesc nvarchar(4000)
DECLARE @tname nvarchar(4000)
DECLARE @updated nvarchar(4000)
DECLARE @vis_state int
DECLARE @Page int
EXEC sp_OAMethod @jResp, 'IntOf', @Page OUT, 'response.result.page'
DECLARE @Pages int
EXEC sp_OAMethod @jResp, 'IntOf', @Pages OUT, 'response.result.pages'
DECLARE @Per_page int
EXEC sp_OAMethod @jResp, 'IntOf', @Per_page OUT, 'response.result.per_page'
DECLARE @Total int
EXEC sp_OAMethod @jResp, 'IntOf', @Total OUT, 'response.result.total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'response.result.tasks'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'BoolOf', @billable OUT, 'response.result.tasks[i].billable'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'response.result.tasks[i].description'
EXEC sp_OAMethod @jResp, 'IntOf', @id OUT, 'response.result.tasks[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'response.result.tasks[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.tasks[i].rate.amount'
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.tasks[i].rate.code'
EXEC sp_OAMethod @jResp, 'IntOf', @taskid OUT, 'response.result.tasks[i].taskid'
EXEC sp_OAMethod @jResp, 'IntOf', @tax1 OUT, 'response.result.tasks[i].tax1'
EXEC sp_OAMethod @jResp, 'IntOf', @tax2 OUT, 'response.result.tasks[i].tax2'
EXEC sp_OAMethod @jResp, 'StringOf', @tdesc OUT, 'response.result.tasks[i].tdesc'
EXEC sp_OAMethod @jResp, 'StringOf', @tname OUT, 'response.result.tasks[i].tname'
EXEC sp_OAMethod @jResp, 'StringOf', @updated OUT, 'response.result.tasks[i].updated'
EXEC sp_OAMethod @jResp, 'IntOf', @vis_state OUT, 'response.result.tasks[i].vis_state'
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>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks
Postman Collection Item JSON
{
"name": "List Tasks",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody); ",
"pm.environment.set(\"taskId\", jsonData.response.result.tasks[0].taskid);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks\n",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"projects",
"tasks\n"
]
}
},
"response": [
{
"name": "List Tasks",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/projects/tasks",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"projects",
"tasks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUQ1lZBwUXEQoWWRFTSxYeA0kJTwBTAlRcAwVXUFcBBwdRUVsPHRpXSBNVBgZUBVtWVltbCl5QCwVcG01XAF8RAWs="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:38:47 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:38:48 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 15,\n \"tasks\": [\n {\n \"billable\": true,\n \"description\": \"\",\n \"id\": 55226,\n \"name\": \"Computer Hardware\",\n \"rate\": {\n \"amount\": \"0.00\",\n \"code\": \"USD\"\n },\n \"taskid\": 55226,\n \"tax1\": 0,\n \"tax2\": 0,\n \"tdesc\": \"\",\n \"tname\": \"Computer Hardware\",\n \"updated\": \"2019-04-18 09:14:53\",\n \"vis_state\": 0\n },\n {\n \"billable\": true,\n \"description\": \"Specific consulting services for a specific reason\",\n \"id\": 70986,\n \"name\": \"Consulting\",\n \"rate\": {\n \"amount\": \"45.00\",\n \"code\": \"USD\"\n },\n \"taskid\": 70986,\n \"tax1\": 0,\n \"tax2\": 0,\n \"tdesc\": \"Specific consulting services for a specific reason\",\n \"tname\": \"Consulting\",\n \"updated\": \"2019-04-23 14:47:22\",\n \"vis_state\": 0\n },\n {\n \"billable\": true,\n \"description\": \"Specific contracting services for a specific reason\",\n \"id\": 70988,\n \"name\": \"Contracting\",\n \"rate\": {\n \"amount\": \"45.00\",\n \"code\": \"USD\"\n },\n \"taskid\": 70988,\n \"tax1\": 0,\n \"tax2\": 0,\n \"tdesc\": \"Specific contracting services for a specific reason\",\n \"tname\": \"Contracting\",\n \"updated\": \"2019-04-23 14:48:11\",\n \"vis_state\": 0\n },\n {\n \"billable\": true,\n \"description\": \"Hourly rate for doing positive things\",\n \"id\": 70992,\n \"name\": \"Saving Planet\",\n \"rate\": {\n \"amount\": \"1000.00\",\n \"code\": \"USD\"\n },\n \"taskid\": 70992,\n \"tax1\": 0,\n \"tax2\": 0,\n \"tdesc\": \"Hourly rate for doing positive things\",\n \"tname\": \"Saving Planet\",\n \"updated\": \"2019-04-23 14:50:57\",\n \"vis_state\": 0\n }\n ],\n \"total\": 4\n }\n }\n}"
}
]
}
