Chilkat Online Tools

phpExt / Salesforce Platform APIs / Individual Member Enrollments

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

// 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 = new CkJsonObject();
$json->UpdateString('enrollmentDate','2021-01-01T00:00:00');
$json->UpdateString('membershipNumber','Member1');
$json->UpdateString('associatedContactDetails.firstName','Name1');
$json->UpdateString('associatedContactDetails.lastName','Name2');
$json->UpdateString('associatedContactDetails.email','ab@email.com');
$json->UpdateString('associatedContactDetails.allowDuplicateRecords','false');
$json->UpdateString('memberStatus','Active');
$json->UpdateString('createTransactionJournals','true');
$json->UpdateString('transactionJournalStatementFrequency','Monthly');
$json->UpdateString('transactionJournalStatementMethod','Mail');
$json->UpdateString('enrollmentChannel','Email');
$json->UpdateString('canReceivePromotions','true');
$json->UpdateString('canReceivePartnerPromotions','true');
$json->UpdateString('membershipEndDate','2022-01-01T00:00:00');

// 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}}/loyalty-programs/:loyaltyProgramName/individual-member-enrollments','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

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

$contactId = $jResp->stringOf('contactId');
$loyaltyProgramMemberId = $jResp->stringOf('loyaltyProgramMemberId');
$loyaltyProgramName = $jResp->stringOf('loyaltyProgramName');
$membershipNumber = $jResp->stringOf('membershipNumber');
$i = 0;
$count_i = $jResp->SizeOfArray('transactionJournals');
while ($i < $count_i) {
    $jResp->put_I($i);
    $activityDate = $jResp->stringOf('transactionJournals[i].activityDate');
    $journalSubType = $jResp->stringOf('transactionJournals[i].journalSubType');
    $journalType = $jResp->stringOf('transactionJournals[i].journalType');
    $loyaltyProgram = $jResp->stringOf('transactionJournals[i].loyaltyProgram');
    $loyaltyProgramMember = $jResp->stringOf('transactionJournals[i].loyaltyProgramMember');
    $referredMember = $jResp->stringOf('transactionJournals[i].referredMember');
    $status = $jResp->stringOf('transactionJournals[i].status');
    $transactionJournalId = $jResp->stringOf('transactionJournals[i].transactionJournalId');
    $i = $i + 1;
}


?>

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