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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary', @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)
-- {
-- "message": null,
-- "status": true,
-- "transactionJournalCount": 1,
-- "transactionJournals": [
-- {
-- "activityDate": "2021-01-01T04:05:05.000Z",
-- "additionalTransactionJournalAttributes": [
-- ],
-- "journalSubTypeName": "Member Enrollment",
-- "journalTypeName": "Accrual",
-- "pointsChange": [
-- ],
-- "transactionJournalId": "0lVJ8000000GmaEMAS",
-- "transactionJournalNumber": "00000008"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @activityDate nvarchar(4000)
DECLARE @journalSubTypeName nvarchar(4000)
DECLARE @journalTypeName nvarchar(4000)
DECLARE @transactionJournalId nvarchar(4000)
DECLARE @transactionJournalNumber nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @message nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'message'
DECLARE @status int
EXEC sp_OAMethod @jResp, 'BoolOf', @status OUT, 'status'
DECLARE @transactionJournalCount int
EXEC sp_OAMethod @jResp, 'IntOf', @transactionJournalCount OUT, 'transactionJournalCount'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'transactionJournals'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @activityDate OUT, 'transactionJournals[i].activityDate'
EXEC sp_OAMethod @jResp, 'StringOf', @journalSubTypeName OUT, 'transactionJournals[i].journalSubTypeName'
EXEC sp_OAMethod @jResp, 'StringOf', @journalTypeName OUT, 'transactionJournals[i].journalTypeName'
EXEC sp_OAMethod @jResp, 'StringOf', @transactionJournalId OUT, 'transactionJournals[i].transactionJournalId'
EXEC sp_OAMethod @jResp, 'StringOf', @transactionJournalNumber OUT, 'transactionJournals[i].transactionJournalNumber'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'transactionJournals[i].additionalTransactionJournalAttributes'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'transactionJournals[i].pointsChange'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
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://domain.com/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary
Postman Collection Item JSON
{
"name": "Transaction Ledger Summary",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"/*",
"pm.variables.set('journalSubTypeName','journalSubTypeName');",
"pm.variables.set('additionalTransactionJournalAttributes','additionalTransactionJournalAttributes');",
"pm.variables.set('journalTypeName','journalTypeName');",
"pm.variables.set('pageNumber','pageNumber');",
"pm.variables.set('periodEndDate','periodEndDate');",
"pm.variables.set('periodStartDate','periodStartDate');",
"*/"
],
"type": "text/javascript",
"packages": {}
}
}
],
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty",
"programs",
":loyaltyProgramName",
"members",
":membershipNumber",
"transaction-ledger-summary"
],
"query": [
{
"key": "journalSubTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal subtype.",
"disabled": true
},
{
"key": "additionalTransactionJournalAttributes",
"value": "",
"description": "Returns the list of transaction journal fields.",
"disabled": true
},
{
"key": "journalTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal type.",
"disabled": true
},
{
"key": "pageNumber",
"value": "",
"description": "Returns the transaction journals for the specified page number.\n",
"disabled": true
},
{
"key": "periodEndDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified end date.",
"disabled": true
},
{
"key": "periodStartDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified start date.",
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": ""
},
{
"key": "membershipNumber",
"value": ""
}
]
},
"description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_transaction_ledger.htm)"
},
"response": [
{
"name": "Transaction Ledger Summary",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"loyalty",
"programs",
":loyaltyProgramName",
"members",
":membershipNumber",
"transaction-ledger-summary"
],
"query": [
{
"key": "journalSubTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal subtype.",
"disabled": true
},
{
"key": "additionalTransactionJournalAttributes",
"value": "",
"description": "Returns the list of transaction journal fields.",
"disabled": true
},
{
"key": "journalTypeName",
"value": "",
"description": "Returns the transaction journals filtered by the specified journal type.",
"disabled": true
},
{
"key": "pageNumber",
"value": "",
"description": "Returns the transaction journals for the specified page number.\n",
"disabled": true
},
{
"key": "periodEndDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified end date.",
"disabled": true
},
{
"key": "periodStartDate",
"value": "",
"description": "Returns the transaction journals filtered by the specified start date.",
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": "NTO Insider"
},
{
"key": "membershipNumber",
"value": "Member123"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 27 May 2024 19:37:52 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"message\": null,\n \"status\": true,\n \"transactionJournalCount\": 1,\n \"transactionJournals\": [\n {\n \"activityDate\": \"2021-01-01T04:05:05.000Z\",\n \"additionalTransactionJournalAttributes\": [],\n \"journalSubTypeName\": \"Member Enrollment\",\n \"journalTypeName\": \"Accrual\",\n \"pointsChange\": [],\n \"transactionJournalId\": \"0lVJ8000000GmaEMAS\",\n \"transactionJournalNumber\": \"00000008\"\n }\n ]\n}"
}
]
}
