Chilkat Online Tools

PureBasic / Salesforce Platform APIs / Individual Member Enrollments

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.

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments","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)

    ; {
    ;   "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

    activityDate.s
    journalSubType.s
    journalType.s
    loyaltyProgram.s
    loyaltyProgramMember.s
    referredMember.s
    status.s
    transactionJournalId.s

    contactId.s = CkJsonObject::ckStringOf(jResp,"contactId")
    loyaltyProgramMemberId.s = CkJsonObject::ckStringOf(jResp,"loyaltyProgramMemberId")
    loyaltyProgramName.s = CkJsonObject::ckStringOf(jResp,"loyaltyProgramName")
    membershipNumber.s = CkJsonObject::ckStringOf(jResp,"membershipNumber")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"transactionJournals")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        activityDate = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].activityDate")
        journalSubType = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].journalSubType")
        journalType = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].journalType")
        loyaltyProgram = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].loyaltyProgram")
        loyaltyProgramMember = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].loyaltyProgramMember")
        referredMember = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].referredMember")
        status = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].status")
        transactionJournalId = CkJsonObject::ckStringOf(jResp,"transactionJournals[i].transactionJournalId")
        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 '{
  "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}"
    }
  ]
}