Chilkat Online Tools

Ruby / Salesforce Platform APIs / Credit Points to Members

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()

# 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": "Accrual",
#         "MembershipNumber": "Member123",
#         "TransactionAmount": "45.0",
#         "CurrencyIsoCode": "EUR",
#         "Status": "Processed"
#       },
#       "PointsToCredit": 100.0
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("processParameters[0].TransactionJournal.ActivityDate","2023-08-27T00:00:00Z")
json.UpdateString("processParameters[0].TransactionJournal.ExternalTransactionNumber","1")
json.UpdateString("processParameters[0].TransactionJournal.InvoiceDate","2023-08-23")
json.UpdateString("processParameters[0].TransactionJournal.JournalTypeName","Accrual")
json.UpdateString("processParameters[0].TransactionJournal.MembershipNumber","Member123")
json.UpdateString("processParameters[0].TransactionJournal.TransactionAmount","45.0")
json.UpdateString("processParameters[0].TransactionJournal.CurrencyIsoCode","EUR")
json.UpdateString("processParameters[0].TransactionJournal.Status","Processed")
json.UpdateNumber("processParameters[0].PointsToCredit","100.0")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "message": null,
#   "outputParameters": {
#     "outputParameters": {
#       "results": [
#         {
#           "PointsCredited": 100
#         }
#       ]
#     }
#   },
#   "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

message = jResp.stringOf("message")
status = jResp.BoolOf("status")
i = 0
count_i = jResp.SizeOfArray("outputParameters.outputParameters.results")
while i < count_i
    jResp.put_I(i)
    PointsCredited = jResp.IntOf("outputParameters.outputParameters.results[i].PointsCredited")
    i = i + 1
end

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":"Accrual",
            "MembershipNumber":"Member123",
            "TransactionAmount":"45.0",
            "CurrencyIsoCode":"EUR",
            "Status":"Processed"
         },
         "PointsToCredit":100.0
      }
   ]
}'
https://domain.com/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName

Postman Collection Item JSON

{
  "name": "Credit Points to Members",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "//pm.variables.set('loyaltyProgramName','xyz');",
          "pm.variables.set('processName','CreditPointsToMembers');"
        ],
        "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\":\"Accrual\",\n            \"MembershipNumber\":\"Member123\",\n            \"TransactionAmount\":\"45.0\",\n            \"CurrencyIsoCode\":\"EUR\",\n            \"Status\":\"Processed\"\n         },\n         \"PointsToCredit\":100.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"
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        },
        {
          "key": "processName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_credit_points_to_members.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_credit_points_to_members.htm)\n\nIn the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke."
  },
  "response": [
    {
      "name": "Credit Points to 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\":\"Accrual\",\n            \"MembershipNumber\":\"Member123\",\n            \"TransactionAmount\":\"45.0\",\n            \"CurrencyIsoCode\":\"EUR\",\n            \"Status\":\"Processed\"\n         },\n         \"PointsToCredit\":100.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"
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            },
            {
              "key": "processName",
              "value": "creditPoints"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 27 May 2024 20:09:08 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                    \"PointsCredited\": 100\n                }\n            ]\n        }\n    },\n    \"simulationDetails\": {},\n    \"status\": true\n}"
    }
  ]
}