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
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', '{{secretId}}'
EXEC sp_OASetProperty @http, 'Password', '{{secretPassword}}'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/api/balances/', @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)
-- {
-- "count": "<integer>",
-- "next": "<string>",
-- "previous": "<string>",
-- "results": [
-- {
-- "id": "<uuid>",
-- "account": {
-- "id": "<uuid>",
-- "name": "<string>",
-- "category": "irure",
-- "currency": "<string>"
-- },
-- "collected_at": "<dateTime>",
-- "value_date": "<date>",
-- "balance": "<number>",
-- "current_balance": "<number>",
-- "statement": "<string>"
-- },
-- {
-- "id": "<uuid>",
-- "account": {
-- "id": "<uuid>",
-- "name": "<string>",
-- "category": "in culpa cupidatat ullamco",
-- "currency": "<string>"
-- },
-- "collected_at": "<dateTime>",
-- "value_date": "<date>",
-- "balance": "<number>",
-- "current_balance": "<number>",
-- "statement": "<string>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Category nvarchar(4000)
DECLARE @v_Currency nvarchar(4000)
DECLARE @collected_at nvarchar(4000)
DECLARE @value_date nvarchar(4000)
DECLARE @balance nvarchar(4000)
DECLARE @current_balance nvarchar(4000)
DECLARE @statement nvarchar(4000)
DECLARE @count nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @count OUT, 'count'
DECLARE @v_next nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_next OUT, 'next'
DECLARE @previous nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @previous OUT, 'previous'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'results'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'results[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'results[i].account.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'results[i].account.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Category OUT, 'results[i].account.category'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Currency OUT, 'results[i].account.currency'
EXEC sp_OAMethod @jResp, 'StringOf', @collected_at OUT, 'results[i].collected_at'
EXEC sp_OAMethod @jResp, 'StringOf', @value_date OUT, 'results[i].value_date'
EXEC sp_OAMethod @jResp, 'StringOf', @balance OUT, 'results[i].balance'
EXEC sp_OAMethod @jResp, 'StringOf', @current_balance OUT, 'results[i].current_balance'
EXEC sp_OAMethod @jResp, 'StringOf', @statement OUT, 'results[i].statement'
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
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/balances/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/balances/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set.",
"disabled": true
}
]
},
"description": "Get a paginated list of all existing balances in your Belvo account. We return up to 100 results per page."
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"irure\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"account\": {\n\t\t\t\t\"id\": \"<uuid>\",\n\t\t\t\t\"name\": \"<string>\",\n\t\t\t\t\"category\": \"in culpa cupidatat ullamco\",\n\t\t\t\t\"currency\": \"<string>\"\n\t\t\t},\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"value_date\": \"<date>\",\n\t\t\t\"balance\": \"<number>\",\n\t\t\t\"current_balance\": \"<number>\",\n\t\t\t\"statement\": \"<string>\"\n\t\t}\n\t]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/balances?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
],
"query": [
{
"key": "page",
"value": "<integer>"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
}
]
}
