Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/loyalty/programs/:loyaltyProgramName/members/:membershipNumber/transaction-ledger-summary",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
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
message = jResp.stringOf("message")
status = jResp.BoolOf("status")
transactionJournalCount = jResp.IntOf("transactionJournalCount")
i = 0
count_i = jResp.SizeOfArray("transactionJournals")
while i < count_i
jResp.put_I(i)
activityDate = jResp.stringOf("transactionJournals[i].activityDate")
journalSubTypeName = jResp.stringOf("transactionJournals[i].journalSubTypeName")
journalTypeName = jResp.stringOf("transactionJournals[i].journalTypeName")
transactionJournalId = jResp.stringOf("transactionJournals[i].transactionJournalId")
transactionJournalNumber = jResp.stringOf("transactionJournals[i].transactionJournalNumber")
j = 0
count_j = jResp.SizeOfArray("transactionJournals[i].additionalTransactionJournalAttributes")
while j < count_j
jResp.put_J(j)
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("transactionJournals[i].pointsChange")
while j < count_j
jResp.put_J(j)
j = j + 1
end
i = i + 1
end
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}"
}
]
}
