Chilkat Online Tools

unicodeCpp / Salesforce Platform APIs / Member Profile

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>

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

    CkHttpW http;
    bool success;

    CkJsonObjectW queryParams;
    queryParams.UpdateString(L"memberId",L"");
    queryParams.UpdateString(L"membershipNumber",L"");
    queryParams.UpdateString(L"programCurrencyName",L"");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken(L"<access_token>");

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "additionalLoyaltyProgramMemberFields": {},
    //   "associatedAccount": null,
    //   "associatedContact": {
    //     "contactId": "003J8000002Yu0ZIAS",
    //     "email": "ab@email.com",
    //     "firstName": "Name1",
    //     "lastName": "Name2"
    //   },
    //   "canReceivePartnerPromotions": true,
    //   "canReceivePromotions": true,
    //   "enrollmentChannel": "Email",
    //   "enrollmentDate": "2021-01-01",
    //   "groupCreatedByMember": null,
    //   "groupName": null,
    //   "lastActivityDate": null,
    //   "loyaltyProgramMemberId": "0lMJ8000000CaRMMA0",
    //   "loyaltyProgramName": "NTO Insider",
    //   "memberCurrencies": [
    //     {
    //       "additionalLoyaltyMemberCurrencyFields": {
    //         "Level_Before_Reset__c": null
    //       },
    //       "escrowPointsBalance": 0,
    //       "expirablePoints": 0,
    //       "lastAccrualProcessedDate": null,
    //       "lastEscrowProcessedDate": null,
    //       "lastExpirationProcessRunDate": null,
    //       "lastPointsAggregationDate": null,
    //       "lastPointsResetDate": null,
    //       "loyaltyMemberCurrencyName": "NTO Qualifying Points",
    //       "loyaltyProgramCurrencyId": "0lcJ8000000CaR7IAK",
    //       "loyaltyProgramCurrencyName": null,
    //       "memberCurrencyId": "0lzJ8000000CaRMIA0",
    //       "nextQualifyingPointsResetDate": "2024-12-31",
    //       "pointsBalance": 0,
    //       "qualifyingPointsBalanceBeforeReset": 0,
    //       "totalEscrowPointsAccrued": 0,
    //       "totalEscrowRolloverPoints": 0,
    //       "totalPointsAccrued": 0,
    //       "totalPointsExpired": 0,
    //       "totalPointsRedeemed": 0
    //     }
    //   ],
    //   "memberStatus": "Active",
    //   "memberTiers": [
    //     {
    //       "additionalLoyaltyMemberTierFields": {},
    //       "areTierBenefitsAssigned": false,
    //       "loyaltyMemberTierId": "0lyJ8000000CaRMIA0",
    //       "loyaltyMemberTierName": "Bronze",
    //       "tierChangeReason": null,
    //       "tierChangeReasonType": null,
    //       "tierEffectiveDate": "2021-01-01",
    //       "tierExpirationDate": null,
    //       "tierGroupId": "0ltJ8000000CaR8IAK",
    //       "tierGroupName": null,
    //       "tierId": "0lgJ80000008OI5IAM",
    //       "tierSequenceNumber": 10
    //     }
    //   ],
    //   "memberType": "Individual",
    //   "membershipEndDate": "2022-01-01",
    //   "membershipLastRenewalDate": null,
    //   "membershipNumber": "Member1",
    //   "referredBy": null,
    //   "relatedCorporateMembershipNumber": null,
    //   "transactionJournalStatementFrequency": "Monthly",
    //   "transactionJournalStatementLastGeneratedDate": null,
    //   "transactionJournalStatementMethod": "Mail"
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *Level_Before_Reset__c = 0;
    int escrowPointsBalance;
    int expirablePoints;
    const wchar_t *lastAccrualProcessedDate = 0;
    const wchar_t *lastEscrowProcessedDate = 0;
    const wchar_t *lastExpirationProcessRunDate = 0;
    const wchar_t *lastPointsAggregationDate = 0;
    const wchar_t *lastPointsResetDate = 0;
    const wchar_t *loyaltyMemberCurrencyName = 0;
    const wchar_t *loyaltyProgramCurrencyId = 0;
    const wchar_t *loyaltyProgramCurrencyName = 0;
    const wchar_t *memberCurrencyId = 0;
    const wchar_t *nextQualifyingPointsResetDate = 0;
    int pointsBalance;
    int qualifyingPointsBalanceBeforeReset;
    int totalEscrowPointsAccrued;
    int totalEscrowRolloverPoints;
    int totalPointsAccrued;
    int totalPointsExpired;
    int totalPointsRedeemed;
    bool areTierBenefitsAssigned;
    const wchar_t *loyaltyMemberTierId = 0;
    const wchar_t *loyaltyMemberTierName = 0;
    const wchar_t *tierChangeReason = 0;
    const wchar_t *tierChangeReasonType = 0;
    const wchar_t *tierEffectiveDate = 0;
    const wchar_t *tierExpirationDate = 0;
    const wchar_t *tierGroupId = 0;
    const wchar_t *tierGroupName = 0;
    const wchar_t *tierId = 0;
    int tierSequenceNumber;

    const wchar_t *associatedAccount = jResp.stringOf(L"associatedAccount");
    const wchar_t *ContactId = jResp.stringOf(L"associatedContact.contactId");
    const wchar_t *v_Email = jResp.stringOf(L"associatedContact.email");
    const wchar_t *FirstName = jResp.stringOf(L"associatedContact.firstName");
    const wchar_t *LastName = jResp.stringOf(L"associatedContact.lastName");
    bool canReceivePartnerPromotions = jResp.BoolOf(L"canReceivePartnerPromotions");
    bool canReceivePromotions = jResp.BoolOf(L"canReceivePromotions");
    const wchar_t *enrollmentChannel = jResp.stringOf(L"enrollmentChannel");
    const wchar_t *enrollmentDate = jResp.stringOf(L"enrollmentDate");
    const wchar_t *groupCreatedByMember = jResp.stringOf(L"groupCreatedByMember");
    const wchar_t *groupName = jResp.stringOf(L"groupName");
    const wchar_t *lastActivityDate = jResp.stringOf(L"lastActivityDate");
    const wchar_t *loyaltyProgramMemberId = jResp.stringOf(L"loyaltyProgramMemberId");
    const wchar_t *loyaltyProgramName = jResp.stringOf(L"loyaltyProgramName");
    const wchar_t *memberStatus = jResp.stringOf(L"memberStatus");
    const wchar_t *memberType = jResp.stringOf(L"memberType");
    const wchar_t *membershipEndDate = jResp.stringOf(L"membershipEndDate");
    const wchar_t *membershipLastRenewalDate = jResp.stringOf(L"membershipLastRenewalDate");
    const wchar_t *membershipNumber = jResp.stringOf(L"membershipNumber");
    const wchar_t *referredBy = jResp.stringOf(L"referredBy");
    const wchar_t *relatedCorporateMembershipNumber = jResp.stringOf(L"relatedCorporateMembershipNumber");
    const wchar_t *transactionJournalStatementFrequency = jResp.stringOf(L"transactionJournalStatementFrequency");
    const wchar_t *transactionJournalStatementLastGeneratedDate = jResp.stringOf(L"transactionJournalStatementLastGeneratedDate");
    const wchar_t *transactionJournalStatementMethod = jResp.stringOf(L"transactionJournalStatementMethod");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"memberCurrencies");
    while (i < count_i) {
        jResp.put_I(i);
        Level_Before_Reset__c = jResp.stringOf(L"memberCurrencies[i].additionalLoyaltyMemberCurrencyFields.Level_Before_Reset__c");
        escrowPointsBalance = jResp.IntOf(L"memberCurrencies[i].escrowPointsBalance");
        expirablePoints = jResp.IntOf(L"memberCurrencies[i].expirablePoints");
        lastAccrualProcessedDate = jResp.stringOf(L"memberCurrencies[i].lastAccrualProcessedDate");
        lastEscrowProcessedDate = jResp.stringOf(L"memberCurrencies[i].lastEscrowProcessedDate");
        lastExpirationProcessRunDate = jResp.stringOf(L"memberCurrencies[i].lastExpirationProcessRunDate");
        lastPointsAggregationDate = jResp.stringOf(L"memberCurrencies[i].lastPointsAggregationDate");
        lastPointsResetDate = jResp.stringOf(L"memberCurrencies[i].lastPointsResetDate");
        loyaltyMemberCurrencyName = jResp.stringOf(L"memberCurrencies[i].loyaltyMemberCurrencyName");
        loyaltyProgramCurrencyId = jResp.stringOf(L"memberCurrencies[i].loyaltyProgramCurrencyId");
        loyaltyProgramCurrencyName = jResp.stringOf(L"memberCurrencies[i].loyaltyProgramCurrencyName");
        memberCurrencyId = jResp.stringOf(L"memberCurrencies[i].memberCurrencyId");
        nextQualifyingPointsResetDate = jResp.stringOf(L"memberCurrencies[i].nextQualifyingPointsResetDate");
        pointsBalance = jResp.IntOf(L"memberCurrencies[i].pointsBalance");
        qualifyingPointsBalanceBeforeReset = jResp.IntOf(L"memberCurrencies[i].qualifyingPointsBalanceBeforeReset");
        totalEscrowPointsAccrued = jResp.IntOf(L"memberCurrencies[i].totalEscrowPointsAccrued");
        totalEscrowRolloverPoints = jResp.IntOf(L"memberCurrencies[i].totalEscrowRolloverPoints");
        totalPointsAccrued = jResp.IntOf(L"memberCurrencies[i].totalPointsAccrued");
        totalPointsExpired = jResp.IntOf(L"memberCurrencies[i].totalPointsExpired");
        totalPointsRedeemed = jResp.IntOf(L"memberCurrencies[i].totalPointsRedeemed");
        i = i + 1;
    }

    i = 0;
    count_i = jResp.SizeOfArray(L"memberTiers");
    while (i < count_i) {
        jResp.put_I(i);
        areTierBenefitsAssigned = jResp.BoolOf(L"memberTiers[i].areTierBenefitsAssigned");
        loyaltyMemberTierId = jResp.stringOf(L"memberTiers[i].loyaltyMemberTierId");
        loyaltyMemberTierName = jResp.stringOf(L"memberTiers[i].loyaltyMemberTierName");
        tierChangeReason = jResp.stringOf(L"memberTiers[i].tierChangeReason");
        tierChangeReasonType = jResp.stringOf(L"memberTiers[i].tierChangeReasonType");
        tierEffectiveDate = jResp.stringOf(L"memberTiers[i].tierEffectiveDate");
        tierExpirationDate = jResp.stringOf(L"memberTiers[i].tierExpirationDate");
        tierGroupId = jResp.stringOf(L"memberTiers[i].tierGroupId");
        tierGroupName = jResp.stringOf(L"memberTiers[i].tierGroupName");
        tierId = jResp.stringOf(L"memberTiers[i].tierId");
        tierSequenceNumber = jResp.IntOf(L"memberTiers[i].tierSequenceNumber");
        i = i + 1;
    }
    }

Curl Command

curl -G -d "memberId="
	-d "membershipNumber="
	-d "programCurrencyName="
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members

Postman Collection Item JSON

{
  "name": "Member Profile",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members?memberId=&membershipNumber=&programCurrencyName=",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "loyalty-programs",
        ":loyaltyProgramName",
        "members"
      ],
      "query": [
        {
          "key": "memberId",
          "value": "",
          "description": "The ID of the loyalty program member."
        },
        {
          "key": "membershipNumber",
          "value": "",
          "description": "The membership number of the loyalty program member."
        },
        {
          "key": "programCurrencyName",
          "value": "",
          "description": "The name of the loyalty program currency associated with the member.\nUse this parameter to get the details of the member’s points-related information for a specific currency."
        }
      ],
      "variable": [
        {
          "key": "loyaltyProgramName",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_profile.htm)"
  },
  "response": [
    {
      "name": "Member Profile",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members?memberId=0lMJ8000000CaRMMA0&membershipNumber=Member1&programCurrencyName=NTO Qualifying Points",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "loyalty-programs",
            ":loyaltyProgramName",
            "members"
          ],
          "query": [
            {
              "key": "memberId",
              "value": "0lMJ8000000CaRMMA0",
              "description": "The ID of the loyalty program member."
            },
            {
              "key": "membershipNumber",
              "value": "Member1",
              "description": "The membership number of the loyalty program member."
            },
            {
              "key": "programCurrencyName",
              "value": "NTO Qualifying Points",
              "description": "The name of the loyalty program currency associated with the member.\nUse this parameter to get the details of the member’s points-related information for a specific currency."
            }
          ],
          "variable": [
            {
              "key": "loyaltyProgramName",
              "value": "NTO Insider"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 May 2024 16:16:23 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    \"additionalLoyaltyProgramMemberFields\": {},\n    \"associatedAccount\": null,\n    \"associatedContact\": {\n        \"contactId\": \"003J8000002Yu0ZIAS\",\n        \"email\": \"ab@email.com\",\n        \"firstName\": \"Name1\",\n        \"lastName\": \"Name2\"\n    },\n    \"canReceivePartnerPromotions\": true,\n    \"canReceivePromotions\": true,\n    \"enrollmentChannel\": \"Email\",\n    \"enrollmentDate\": \"2021-01-01\",\n    \"groupCreatedByMember\": null,\n    \"groupName\": null,\n    \"lastActivityDate\": null,\n    \"loyaltyProgramMemberId\": \"0lMJ8000000CaRMMA0\",\n    \"loyaltyProgramName\": \"NTO Insider\",\n    \"memberCurrencies\": [\n        {\n            \"additionalLoyaltyMemberCurrencyFields\": {\n                \"Level_Before_Reset__c\": null\n            },\n            \"escrowPointsBalance\": 0,\n            \"expirablePoints\": 0,\n            \"lastAccrualProcessedDate\": null,\n            \"lastEscrowProcessedDate\": null,\n            \"lastExpirationProcessRunDate\": null,\n            \"lastPointsAggregationDate\": null,\n            \"lastPointsResetDate\": null,\n            \"loyaltyMemberCurrencyName\": \"NTO Qualifying Points\",\n            \"loyaltyProgramCurrencyId\": \"0lcJ8000000CaR7IAK\",\n            \"loyaltyProgramCurrencyName\": null,\n            \"memberCurrencyId\": \"0lzJ8000000CaRMIA0\",\n            \"nextQualifyingPointsResetDate\": \"2024-12-31\",\n            \"pointsBalance\": 0,\n            \"qualifyingPointsBalanceBeforeReset\": 0,\n            \"totalEscrowPointsAccrued\": 0,\n            \"totalEscrowRolloverPoints\": 0,\n            \"totalPointsAccrued\": 0,\n            \"totalPointsExpired\": 0,\n            \"totalPointsRedeemed\": 0\n        }\n    ],\n    \"memberStatus\": \"Active\",\n    \"memberTiers\": [\n        {\n            \"additionalLoyaltyMemberTierFields\": {},\n            \"areTierBenefitsAssigned\": false,\n            \"loyaltyMemberTierId\": \"0lyJ8000000CaRMIA0\",\n            \"loyaltyMemberTierName\": \"Bronze\",\n            \"tierChangeReason\": null,\n            \"tierChangeReasonType\": null,\n            \"tierEffectiveDate\": \"2021-01-01\",\n            \"tierExpirationDate\": null,\n            \"tierGroupId\": \"0ltJ8000000CaR8IAK\",\n            \"tierGroupName\": null,\n            \"tierId\": \"0lgJ80000008OI5IAM\",\n            \"tierSequenceNumber\": 10\n        }\n    ],\n    \"memberType\": \"Individual\",\n    \"membershipEndDate\": \"2022-01-01\",\n    \"membershipLastRenewalDate\": null,\n    \"membershipNumber\": \"Member1\",\n    \"referredBy\": null,\n    \"relatedCorporateMembershipNumber\": null,\n    \"transactionJournalStatementFrequency\": \"Monthly\",\n    \"transactionJournalStatementLastGeneratedDate\": null,\n    \"transactionJournalStatementMethod\": \"Mail\"\n}"
    }
  ]
}