Chilkat Online Tools

SQL Server / Salesforce Platform APIs / Credit Points to Members

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
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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.

    -- {
    --   "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
    --     }
    --   ]
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.ActivityDate', '2023-08-27T00:00:00Z'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.ExternalTransactionNumber', '1'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.InvoiceDate', '2023-08-23'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.JournalTypeName', 'Accrual'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.MembershipNumber', 'Member123'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.TransactionAmount', '45.0'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.CurrencyIsoCode', 'EUR'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'processParameters[0].TransactionJournal.Status', 'Processed'
    EXEC sp_OAMethod @json, 'UpdateNumber', @success OUT, 'processParameters[0].PointsToCredit', '100.0'

    -- 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/services/data/v{{version}}/connect/loyalty/programs/:loyaltyProgramName/program-processes/:processName', '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

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END
    EXEC @hr = sp_OADestroy @resp

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

    DECLARE @PointsCredited 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 @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'outputParameters.outputParameters.results'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'IntOf', @PointsCredited OUT, 'outputParameters.outputParameters.results[i].PointsCredited'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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}"
    }
  ]
}