Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("memberId","")
queryParams.UpdateString("membershipNumber","")
queryParams.UpdateString("programCurrencyName","")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
associatedAccount = jResp.stringOf("associatedAccount")
ContactId = jResp.stringOf("associatedContact.contactId")
v_Email = jResp.stringOf("associatedContact.email")
FirstName = jResp.stringOf("associatedContact.firstName")
LastName = jResp.stringOf("associatedContact.lastName")
canReceivePartnerPromotions = jResp.BoolOf("canReceivePartnerPromotions")
canReceivePromotions = jResp.BoolOf("canReceivePromotions")
enrollmentChannel = jResp.stringOf("enrollmentChannel")
enrollmentDate = jResp.stringOf("enrollmentDate")
groupCreatedByMember = jResp.stringOf("groupCreatedByMember")
groupName = jResp.stringOf("groupName")
lastActivityDate = jResp.stringOf("lastActivityDate")
loyaltyProgramMemberId = jResp.stringOf("loyaltyProgramMemberId")
loyaltyProgramName = jResp.stringOf("loyaltyProgramName")
memberStatus = jResp.stringOf("memberStatus")
memberType = jResp.stringOf("memberType")
membershipEndDate = jResp.stringOf("membershipEndDate")
membershipLastRenewalDate = jResp.stringOf("membershipLastRenewalDate")
membershipNumber = jResp.stringOf("membershipNumber")
referredBy = jResp.stringOf("referredBy")
relatedCorporateMembershipNumber = jResp.stringOf("relatedCorporateMembershipNumber")
transactionJournalStatementFrequency = jResp.stringOf("transactionJournalStatementFrequency")
transactionJournalStatementLastGeneratedDate = jResp.stringOf("transactionJournalStatementLastGeneratedDate")
transactionJournalStatementMethod = jResp.stringOf("transactionJournalStatementMethod")
i = 0
count_i = jResp.SizeOfArray("memberCurrencies")
while i < count_i
jResp.put_I(i)
Level_Before_Reset__c = jResp.stringOf("memberCurrencies[i].additionalLoyaltyMemberCurrencyFields.Level_Before_Reset__c")
escrowPointsBalance = jResp.IntOf("memberCurrencies[i].escrowPointsBalance")
expirablePoints = jResp.IntOf("memberCurrencies[i].expirablePoints")
lastAccrualProcessedDate = jResp.stringOf("memberCurrencies[i].lastAccrualProcessedDate")
lastEscrowProcessedDate = jResp.stringOf("memberCurrencies[i].lastEscrowProcessedDate")
lastExpirationProcessRunDate = jResp.stringOf("memberCurrencies[i].lastExpirationProcessRunDate")
lastPointsAggregationDate = jResp.stringOf("memberCurrencies[i].lastPointsAggregationDate")
lastPointsResetDate = jResp.stringOf("memberCurrencies[i].lastPointsResetDate")
loyaltyMemberCurrencyName = jResp.stringOf("memberCurrencies[i].loyaltyMemberCurrencyName")
loyaltyProgramCurrencyId = jResp.stringOf("memberCurrencies[i].loyaltyProgramCurrencyId")
loyaltyProgramCurrencyName = jResp.stringOf("memberCurrencies[i].loyaltyProgramCurrencyName")
memberCurrencyId = jResp.stringOf("memberCurrencies[i].memberCurrencyId")
nextQualifyingPointsResetDate = jResp.stringOf("memberCurrencies[i].nextQualifyingPointsResetDate")
pointsBalance = jResp.IntOf("memberCurrencies[i].pointsBalance")
qualifyingPointsBalanceBeforeReset = jResp.IntOf("memberCurrencies[i].qualifyingPointsBalanceBeforeReset")
totalEscrowPointsAccrued = jResp.IntOf("memberCurrencies[i].totalEscrowPointsAccrued")
totalEscrowRolloverPoints = jResp.IntOf("memberCurrencies[i].totalEscrowRolloverPoints")
totalPointsAccrued = jResp.IntOf("memberCurrencies[i].totalPointsAccrued")
totalPointsExpired = jResp.IntOf("memberCurrencies[i].totalPointsExpired")
totalPointsRedeemed = jResp.IntOf("memberCurrencies[i].totalPointsRedeemed")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("memberTiers")
while i < count_i
jResp.put_I(i)
areTierBenefitsAssigned = jResp.BoolOf("memberTiers[i].areTierBenefitsAssigned")
loyaltyMemberTierId = jResp.stringOf("memberTiers[i].loyaltyMemberTierId")
loyaltyMemberTierName = jResp.stringOf("memberTiers[i].loyaltyMemberTierName")
tierChangeReason = jResp.stringOf("memberTiers[i].tierChangeReason")
tierChangeReasonType = jResp.stringOf("memberTiers[i].tierChangeReasonType")
tierEffectiveDate = jResp.stringOf("memberTiers[i].tierEffectiveDate")
tierExpirationDate = jResp.stringOf("memberTiers[i].tierExpirationDate")
tierGroupId = jResp.stringOf("memberTiers[i].tierGroupId")
tierGroupName = jResp.stringOf("memberTiers[i].tierGroupName")
tierId = jResp.stringOf("memberTiers[i].tierId")
tierSequenceNumber = jResp.IntOf("memberTiers[i].tierSequenceNumber")
i = i + 1
end
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}"
}
]
}
