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}}/abilities', @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)
-- {
-- "abilities": [
-- {
-- "name": "can_view_projects",
-- "value": true
-- },
-- {
-- "name": "can_create_projects",
-- "value": true
-- },
-- {
-- "name": "can_create_services",
-- "value": true
-- },
-- {
-- "name": "can_view_services",
-- "value": true
-- },
-- {
-- "name": "can_view_time_entries",
-- "value": true
-- },
-- {
-- "name": "can_create_time_entries",
-- "value": true
-- },
-- {
-- "name": "can_mark_time_entries_billed",
-- "value": true
-- },
-- {
-- "name": "can_view_team_time_entries",
-- "value": true
-- },
-- {
-- "name": "can_view_time_tracking_settings",
-- "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 @name nvarchar(4000)
DECLARE @value int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
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}}/abilities
Postman Collection Item JSON
{
"name": "Abilities",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/abilities",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"abilities"
]
}
},
"response": [
{
"name": "Abilities",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/abilities",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"abilities"
]
}
},
"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.22.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNA1ILVAtMUVFBHRdcEl4UQQEBDFYDDw9RR1kBEhBSQlgTFlJTEU5WT1IeUg1TCw4FBwVVAVMAVABRVhoaUEpBWwYBAlJbUwIDVVxUAAJUVkFOVgNUEV1l"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Mon, 23 Apr 2018 17:47:51 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": "477"
},
{
"key": "Date",
"value": "Tue, 23 Apr 2019 17:47:51 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17335-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 \"abilities\": [\n {\n \"name\": \"can_view_projects\",\n \"value\": true\n },\n {\n \"name\": \"can_create_projects\",\n \"value\": true\n },\n {\n \"name\": \"can_create_services\",\n \"value\": true\n },\n {\n \"name\": \"can_view_services\",\n \"value\": true\n },\n {\n \"name\": \"can_view_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_create_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_mark_time_entries_billed\",\n \"value\": true\n },\n {\n \"name\": \"can_view_team_time_entries\",\n \"value\": true\n },\n {\n \"name\": \"can_view_time_tracking_settings\",\n \"value\": true\n }\n ]\n}"
}
]
}
