Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Individual Member Enrollments

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcActivityDate
LOCAL lcJournalSubType
LOCAL lcJournalType
LOCAL lcLoyaltyProgram
LOCAL lcLoyaltyProgramMember
LOCAL lcReferredMember
LOCAL lcStatus
LOCAL lcTransactionJournalId
LOCAL lcContactId
LOCAL lcLoyaltyProgramMemberId
LOCAL lcLoyaltyProgramName
LOCAL lcMembershipNumber
LOCAL i
LOCAL lnCount_i

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Use this online tool to generate code from sample JSON: Generate Code to Create JSON

* The following JSON is sent in the request body.

* {
*   "enrollmentDate": "2021-01-01T00:00:00",
*   "membershipNumber": "Member1",
*   "associatedContactDetails": {
*     "firstName": "Name1",
*     "lastName": "Name2",
*     "email": "ab@email.com",
*     "allowDuplicateRecords": "false"
*   },
*   "memberStatus": "Active",
*   "createTransactionJournals": "true",
*   "transactionJournalStatementFrequency": "Monthly",
*   "transactionJournalStatementMethod": "Mail",
*   "enrollmentChannel": "Email",
*   "canReceivePromotions": "true",
*   "canReceivePartnerPromotions": "true",
*   "membershipEndDate": "2022-01-01T00:00:00"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("enrollmentDate","2021-01-01T00:00:00")
loJson.UpdateString("membershipNumber","Member1")
loJson.UpdateString("associatedContactDetails.firstName","Name1")
loJson.UpdateString("associatedContactDetails.lastName","Name2")
loJson.UpdateString("associatedContactDetails.email","ab@email.com")
loJson.UpdateString("associatedContactDetails.allowDuplicateRecords","false")
loJson.UpdateString("memberStatus","Active")
loJson.UpdateString("createTransactionJournals","true")
loJson.UpdateString("transactionJournalStatementFrequency","Monthly")
loJson.UpdateString("transactionJournalStatementMethod","Mail")
loJson.UpdateString("enrollmentChannel","Email")
loJson.UpdateString("canReceivePromotions","true")
loJson.UpdateString("canReceivePartnerPromotions","true")
loJson.UpdateString("membershipEndDate","2022-01-01T00:00:00")

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "contactId": "003J8000002Yu0Z",
*   "loyaltyProgramMemberId": "0lMJ8000000CaRM",
*   "loyaltyProgramName": "NTO Insider",
*   "membershipNumber": "Member1",
*   "transactionJournals": [
*     {
*       "activityDate": "2020-12-31T23:00:00.000Z",
*       "journalSubType": "Member Enrollment",
*       "journalType": "Accrual",
*       "loyaltyProgram": "NTO Insider",
*       "loyaltyProgramMember": "Member1",
*       "referredMember": null,
*       "status": "Processed",
*       "transactionJournalId": "0lVJ8000000GmaJ"
*     }
*   ]
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcContactId = loJResp.StringOf("contactId")
lcLoyaltyProgramMemberId = loJResp.StringOf("loyaltyProgramMemberId")
lcLoyaltyProgramName = loJResp.StringOf("loyaltyProgramName")
lcMembershipNumber = loJResp.StringOf("membershipNumber")
i = 0
lnCount_i = loJResp.SizeOfArray("transactionJournals")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcActivityDate = loJResp.StringOf("transactionJournals[i].activityDate")
    lcJournalSubType = loJResp.StringOf("transactionJournals[i].journalSubType")
    lcJournalType = loJResp.StringOf("transactionJournals[i].journalType")
    lcLoyaltyProgram = loJResp.StringOf("transactionJournals[i].loyaltyProgram")
    lcLoyaltyProgramMember = loJResp.StringOf("transactionJournals[i].loyaltyProgramMember")
    lcReferredMember = loJResp.StringOf("transactionJournals[i].referredMember")
    lcStatus = loJResp.StringOf("transactionJournals[i].status")
    lcTransactionJournalId = loJResp.StringOf("transactionJournals[i].transactionJournalId")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
  "enrollmentDate" : "2021-01-01T00:00:00",
  "membershipNumber" : "Member1",
  "associatedContactDetails" : {
    "firstName" : "Name1",
    "lastName" : "Name2",
    "email" : "ab@email.com",
    "allowDuplicateRecords" : "false"
  },

  "memberStatus" : "Active",
  "createTransactionJournals" : "true",
  "transactionJournalStatementFrequency" : "Monthly",
  "transactionJournalStatementMethod" : "Mail",
  "enrollmentChannel" : "Email",
  "canReceivePromotions": "true",
  "canReceivePartnerPromotions" : "true",
  "membershipEndDate" : "2022-01-01T00:00:00"
}'
https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments

Postman Collection Item JSON

{
  "name": "Individual Member Enrollments",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"enrollmentDate\" : \"2021-01-01T00:00:00\",\n  \"membershipNumber\" : \"Member1\",\n  \"associatedContactDetails\" : {\n    \"firstName\" : \"Name1\",\n    \"lastName\" : \"Name2\",\n    \"email\" : \"ab@email.com\",\n    \"allowDuplicateRecords\" : \"false\"\n  },\n\n  \"memberStatus\" : \"Active\",\n  \"createTransactionJournals\" : \"true\",\n  \"transactionJournalStatementFrequency\" : \"Monthly\",\n  \"transactionJournalStatementMethod\" : \"Mail\",\n  \"enrollmentChannel\" : \"Email\",\n  \"canReceivePromotions\": \"true\",\n  \"canReceivePartnerPromotions\" : \"true\",\n  \"membershipEndDate\" : \"2022-01-01T00:00:00\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "loyalty-programs",
        ":loyaltyProgramName",
        "individual-member-enrollments"
      ],
      "query": [
        {
          "key": "",
          "value": "",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm)"
  },
  "response": [
    {
      "name": "Individual Member Enrollments",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"enrollmentDate\" : \"2021-01-01T00:00:00\",\n  \"membershipNumber\" : \"Member1\",\n  \"associatedContactDetails\" : {\n    \"firstName\" : \"Name1\",\n    \"lastName\" : \"Name2\",\n    \"email\" : \"ab@email.com\",\n    \"allowDuplicateRecords\" : \"false\"\n  },\n\n  \"memberStatus\" : \"Active\",\n  \"createTransactionJournals\" : \"true\",\n  \"transactionJournalStatementFrequency\" : \"Monthly\",\n  \"transactionJournalStatementMethod\" : \"Mail\",\n  \"enrollmentChannel\" : \"Email\",\n  \"canReceivePromotions\": \"true\",\n  \"canReceivePartnerPromotions\" : \"true\",\n  \"membershipEndDate\" : \"2022-01-01T00:00:00\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "loyalty-programs",
            ":loyaltyProgramName",
            "individual-member-enrollments"
          ],
          "query": [
            {
              "key": "",
              "value": null,
              "disabled": true
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 May 2024 15:39:01 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    \"contactId\": \"003J8000002Yu0Z\",\n    \"loyaltyProgramMemberId\": \"0lMJ8000000CaRM\",\n    \"loyaltyProgramName\": \"NTO Insider\",\n    \"membershipNumber\": \"Member1\",\n    \"transactionJournals\": [\n        {\n            \"activityDate\": \"2020-12-31T23:00:00.000Z\",\n            \"journalSubType\": \"Member Enrollment\",\n            \"journalType\": \"Accrual\",\n            \"loyaltyProgram\": \"NTO Insider\",\n            \"loyaltyProgramMember\": \"Member1\",\n            \"referredMember\": null,\n            \"status\": \"Processed\",\n            \"transactionJournalId\": \"0lVJ8000000GmaJ\"\n        }\n    ]\n}"
    }
  ]
}