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
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', '{{secretId}}'
EXEC sp_OASetProperty @http, 'Password', '{{secretPassword}}'
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://domain.com/api/tax-returns/:id/', @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)
-- {
-- "id": "<uuid>",
-- "link": "<uuid>",
-- "collected_at": "<dateTime>",
-- "informacion_general": "<object>",
-- "sueldos_salarios": "<object>",
-- "servicios_profesionales": "<object>",
-- "deducciones_personales": "<object>",
-- "determinacion_impuesto": "<object>",
-- "retenciones": "<object>",
-- "dividendos": "<object>",
-- "datos_informativos": "<object>",
-- "pdf": "<binary>"
-- }
-- 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)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @link nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @link OUT, 'link'
DECLARE @collected_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @collected_at OUT, 'collected_at'
DECLARE @informacion_general nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @informacion_general OUT, 'informacion_general'
DECLARE @sueldos_salarios nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @sueldos_salarios OUT, 'sueldos_salarios'
DECLARE @servicios_profesionales nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @servicios_profesionales OUT, 'servicios_profesionales'
DECLARE @deducciones_personales nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @deducciones_personales OUT, 'deducciones_personales'
DECLARE @determinacion_impuesto nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @determinacion_impuesto OUT, 'determinacion_impuesto'
DECLARE @retenciones nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @retenciones OUT, 'retenciones'
DECLARE @dividendos nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @dividendos OUT, 'dividendos'
DECLARE @datos_informativos nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @datos_informativos OUT, 'datos_informativos'
DECLARE @pdf nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pdf OUT, 'pdf'
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/tax-returns/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/tax-returns/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `tax-return.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific tax return."
},
"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/tax-returns/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"link\": \"<uuid>\",\n\t\"collected_at\": \"<dateTime>\",\n\t\"informacion_general\": \"<object>\",\n\t\"sueldos_salarios\": \"<object>\",\n\t\"servicios_profesionales\": \"<object>\",\n\t\"deducciones_personales\": \"<object>\",\n\t\"determinacion_impuesto\": \"<object>\",\n\t\"retenciones\": \"<object>\",\n\t\"dividendos\": \"<object>\",\n\t\"datos_informativos\": \"<object>\",\n\t\"pdf\": \"<binary>\"\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/tax-returns/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"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]"
},
{
"name": "Too Many Sessions",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/tax-returns/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"tax-returns",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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]"
}
]
}
