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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "type": "Summary",
-- "format": "JSON",
-- "queryParameters": {
-- "dateFrom": "2020-10-01T21:00:28.451Z",
-- "dateTo": "2020-12-30T21:00:28.451Z",
-- "statuses": [
-- "Valid",
-- "Cancelled",
-- "Rejected"
-- ],
-- "productsInternalCodes": [
-- ],
-- "receiverSenderId": "",
-- "receiverSenderType": "0",
-- "branchNumber": "",
-- "itemCodes": [
-- {
-- "codeValue": "",
-- "codeType": ""
-- }
-- ],
-- "documentTypeNames": [
-- ]
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'Summary'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'format', 'JSON'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.dateFrom', '2020-10-01T21:00:28.451Z'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.dateTo', '2020-12-30T21:00:28.451Z'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.statuses[0]', 'Valid'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.statuses[1]', 'Cancelled'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.statuses[2]', 'Rejected'
EXEC sp_OAMethod @json, 'UpdateNewArray', @success OUT, 'queryParameters.productsInternalCodes'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.receiverSenderId', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.receiverSenderType', '0'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.branchNumber', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.itemCodes[0].codeValue', ''
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'queryParameters.itemCodes[0].codeType', ''
EXEC sp_OAMethod @json, 'UpdateNewArray', @success OUT, 'queryParameters.documentTypeNames'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/api/v1/documentPackages/requests', 'application/json', @json
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 @json
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 @json
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"type": "Summary",
"format": "JSON",
"queryParameters": {
"dateFrom": "2020-10-01T21:00:28.451Z",
"dateTo": "2020-12-30T21:00:28.451Z",
"statuses": [
"Valid",
"Cancelled",
"Rejected"
],
"productsInternalCodes": [],
"receiverSenderId": "",
"receiverSenderType": "0",
"branchNumber": "",
"itemCodes": [
{
"codeValue": "",
"codeType": ""
}
],
"documentTypeNames": []
}
}'
https://domain.com/api/v1/documentPackages/requests
Postman Collection Item JSON
{
"name": "5. Request Document Package",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{generatedAccessToken}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\r\n \"type\": \"Summary\",\r\n \"format\": \"JSON\",\r\n \"queryParameters\": {\r\n \"dateFrom\": \"2020-10-01T21:00:28.451Z\",\r\n \"dateTo\": \"2020-12-30T21:00:28.451Z\",\r\n \"statuses\": [\r\n \"Valid\",\r\n \"Cancelled\",\r\n \"Rejected\"\r\n ],\r\n \"productsInternalCodes\": [],\r\n \"receiverSenderId\": \"\",\r\n \"receiverSenderType\": \"0\",\r\n \"branchNumber\": \"\",\r\n \"itemCodes\": [\r\n {\r\n \"codeValue\": \"\",\r\n \"codeType\": \"\"\r\n }\r\n ],\r\n \"documentTypeNames\": []\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{apiBaseUrl}}/api/v1/documentPackages/requests",
"host": [
"{{apiBaseUrl}}"
],
"path": [
"api",
"v1",
"documentPackages",
"requests"
]
}
},
"response": [
]
}