Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "processParameters": [
; {
; "TransactionJournal": {
; "ActivityDate": "2023-08-27T00:00:00Z",
; "ExternalTransactionNumber": "1",
; "InvoiceDate": "2023-08-23",
; "JournalTypeName": "Redemption",
; "MembershipNumber": "Member123",
; "TransactionAmount": "45.0",
; "CurrencyIsoCode": "EUR",
; "Status": "Processed"
; },
; "PointsToDebit": 6.0
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.ActivityDate","2023-08-27T00:00:00Z")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.ExternalTransactionNumber","1")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.InvoiceDate","2023-08-23")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.JournalTypeName","Redemption")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.MembershipNumber","Member123")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.TransactionAmount","45.0")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.CurrencyIsoCode","EUR")
CkJsonObject::ckUpdateString(json,"processParameters[0].TransactionJournal.Status","Processed")
CkJsonObject::ckUpdateNumber(json,"processParameters[0].PointsToDebit","6.0")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "message": null,
; "outputParameters": {
; "outputParameters": {
; "results": [
; {
; "PointsDebited": 6
; }
; ]
; }
; },
; "simulationDetails": {},
; "status": true
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
PointsDebited.i
message.s = CkJsonObject::ckStringOf(jResp,"message")
status.i = CkJsonObject::ckBoolOf(jResp,"status")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"outputParameters.outputParameters.results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
PointsDebited = CkJsonObject::ckIntOf(jResp,"outputParameters.outputParameters.results[i].PointsDebited")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"processParameters": [
{
"TransactionJournal": {
"ActivityDate": "2023-08-27T00:00:00Z",
"ExternalTransactionNumber": "1",
"InvoiceDate": "2023-08-23",
"JournalTypeName": "Redemption",
"MembershipNumber":"Member123",
"TransactionAmount": "45.0",
"CurrencyIsoCode":"EUR",
"Status":"Processed"
},
"PointsToDebit": 6.0
}
]
}'
https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName
Postman Collection Item JSON
{
"name": "Debit Points from Members",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"//pm.variables.set('loyaltyProgramName','xyz');",
"pm.variables.set('processName','DebitPointsFromMembers');"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processParameters\": [\n {\n \"TransactionJournal\": {\n \"ActivityDate\": \"2023-08-27T00:00:00Z\",\n \"ExternalTransactionNumber\": \"1\",\n \"InvoiceDate\": \"2023-08-23\",\n \"JournalTypeName\": \"Redemption\",\n \"MembershipNumber\":\"Member123\",\n \"TransactionAmount\": \"45.0\",\n \"CurrencyIsoCode\":\"EUR\",\n \"Status\":\"Processed\"\n },\n \"PointsToDebit\": 6.0\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"loyalty",
"programs",
":loyaltyProgramName",
"program-processes",
":processName"
],
"query": [
{
"key": "journalTypeId",
"value": "",
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": ""
},
{
"key": "processName",
"value": ""
}
]
},
"description": "[Debit Points from Members](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_debit_points_from_members.htm)\n\nNOTE:\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke."
},
"response": [
{
"name": "Debit Points from Members",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"processParameters\": [\n {\n \"TransactionJournal\": {\n \"ActivityDate\": \"2023-08-27T00:00:00Z\",\n \"ExternalTransactionNumber\": \"1\",\n \"InvoiceDate\": \"2023-08-23\",\n \"JournalTypeName\": \"Redemption\",\n \"MembershipNumber\":\"Member123\",\n \"TransactionAmount\": \"45.0\",\n \"CurrencyIsoCode\":\"EUR\",\n \"Status\":\"Processed\"\n },\n \"PointsToDebit\": 6.0\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"loyalty",
"programs",
":loyaltyProgramName",
"program-processes",
":processName"
],
"query": [
{
"key": "journalTypeId",
"value": null,
"disabled": true
}
],
"variable": [
{
"key": "loyaltyProgramName",
"value": "NTO Insider"
},
{
"key": "processName",
"value": "debitPoints"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 27 May 2024 20:21:45 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 \"outputParameters\": {\n \"outputParameters\": {\n \"results\": [\n {\n \"PointsDebited\": 6\n }\n ]\n }\n },\n \"simulationDetails\": {},\n \"status\": true\n}"
}
]
}
