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
DECLARE @iTmp0 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
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'DocumentId', 'a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ReceiptNumber', '1234566788'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'DocumentTypeCode', 'R'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'DocumentTypeName', 'Return Receipt'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'DocumentTypeVersionNumber', '1.1'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'ReceiverId', 113317713
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'ReceiverName', 'Taxpayer1'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'Status', 'Valid'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'SortBy', 'DateTimeReceived'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'SortDir', 'Asc'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'PageNo', 1
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'PageSize', 10
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/api/v1/receiptsubmissions/:submissionUuid/details', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
END
GO
Curl Command
curl -G -d "DocumentId=a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0"
-d "ReceiptNumber=1234566788"
-d "DocumentTypeCode=R"
-d "DocumentTypeName=Return%20Receipt"
-d "DocumentTypeVersionNumber=1.1"
-d "ReceiverId=113317713"
-d "ReceiverName=Taxpayer1"
-d "Status=Valid"
-d "SortBy=DateTimeReceived"
-d "SortDir=Asc"
-d "PageNo=1"
-d "PageSize=10"
-H "Authorization: Bearer <access_token>"
https://domain.com/api/v1/receiptsubmissions/:submissionUuid/details
Postman Collection Item JSON
{
"name": "6. Get Receipt Submission",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{generatedAccessToken}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{apiBaseUrl}}/api/v1/receiptsubmissions/:submissionUuid/details?DocumentId=a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0&ReceiptNumber=1234566788&DocumentTypeCode=R&DocumentTypeName=Return Receipt&DocumentTypeVersionNumber=1.1&ReceiverId=113317713&ReceiverName=Taxpayer1&Status=Valid&SortBy=DateTimeReceived&SortDir=Asc&PageNo=1&PageSize=10",
"host": [
"{{apiBaseUrl}}"
],
"path": [
"api",
"v1",
"receiptsubmissions",
":submissionUuid",
"details"
],
"query": [
{
"key": "DocumentId",
"value": "a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0"
},
{
"key": "ReceiptNumber",
"value": "1234566788"
},
{
"key": "DocumentTypeCode",
"value": "R"
},
{
"key": "DocumentTypeName",
"value": "Return Receipt"
},
{
"key": "DocumentTypeVersionNumber",
"value": "1.1"
},
{
"key": "ReceiverId",
"value": "113317713"
},
{
"key": "ReceiverName",
"value": "Taxpayer1"
},
{
"key": "Status",
"value": "Valid"
},
{
"key": "SortBy",
"value": "DateTimeReceived"
},
{
"key": "SortDir",
"value": "Asc"
},
{
"key": "PageNo",
"value": "1"
},
{
"key": "PageSize",
"value": "10"
}
],
"variable": [
{
"key": "submissionUuid",
"value": "RAQTYQ327VC4Q9170KJYMG5G10",
"description": "(Required) "
}
]
}
},
"response": [
]
}