Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "memberId" ""
CkJsonObject_UpdateString $queryParams "membershipNumber" ""
CkJsonObject_UpdateString $queryParams "programCurrencyName" ""
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set resp [new_CkHttpResponse]
set success [CkHttp_HttpParams $http "GET" "https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members" $queryParams $resp]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set associatedAccount [CkJsonObject_stringOf $jResp "associatedAccount"]
set ContactId [CkJsonObject_stringOf $jResp "associatedContact.contactId"]
set v_Email [CkJsonObject_stringOf $jResp "associatedContact.email"]
set FirstName [CkJsonObject_stringOf $jResp "associatedContact.firstName"]
set LastName [CkJsonObject_stringOf $jResp "associatedContact.lastName"]
set canReceivePartnerPromotions [CkJsonObject_BoolOf $jResp "canReceivePartnerPromotions"]
set canReceivePromotions [CkJsonObject_BoolOf $jResp "canReceivePromotions"]
set enrollmentChannel [CkJsonObject_stringOf $jResp "enrollmentChannel"]
set enrollmentDate [CkJsonObject_stringOf $jResp "enrollmentDate"]
set groupCreatedByMember [CkJsonObject_stringOf $jResp "groupCreatedByMember"]
set groupName [CkJsonObject_stringOf $jResp "groupName"]
set lastActivityDate [CkJsonObject_stringOf $jResp "lastActivityDate"]
set loyaltyProgramMemberId [CkJsonObject_stringOf $jResp "loyaltyProgramMemberId"]
set loyaltyProgramName [CkJsonObject_stringOf $jResp "loyaltyProgramName"]
set memberStatus [CkJsonObject_stringOf $jResp "memberStatus"]
set memberType [CkJsonObject_stringOf $jResp "memberType"]
set membershipEndDate [CkJsonObject_stringOf $jResp "membershipEndDate"]
set membershipLastRenewalDate [CkJsonObject_stringOf $jResp "membershipLastRenewalDate"]
set membershipNumber [CkJsonObject_stringOf $jResp "membershipNumber"]
set referredBy [CkJsonObject_stringOf $jResp "referredBy"]
set relatedCorporateMembershipNumber [CkJsonObject_stringOf $jResp "relatedCorporateMembershipNumber"]
set transactionJournalStatementFrequency [CkJsonObject_stringOf $jResp "transactionJournalStatementFrequency"]
set transactionJournalStatementLastGeneratedDate [CkJsonObject_stringOf $jResp "transactionJournalStatementLastGeneratedDate"]
set transactionJournalStatementMethod [CkJsonObject_stringOf $jResp "transactionJournalStatementMethod"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "memberCurrencies"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Level_Before_Reset__c [CkJsonObject_stringOf $jResp "memberCurrencies[i].additionalLoyaltyMemberCurrencyFields.Level_Before_Reset__c"]
set escrowPointsBalance [CkJsonObject_IntOf $jResp "memberCurrencies[i].escrowPointsBalance"]
set expirablePoints [CkJsonObject_IntOf $jResp "memberCurrencies[i].expirablePoints"]
set lastAccrualProcessedDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].lastAccrualProcessedDate"]
set lastEscrowProcessedDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].lastEscrowProcessedDate"]
set lastExpirationProcessRunDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].lastExpirationProcessRunDate"]
set lastPointsAggregationDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].lastPointsAggregationDate"]
set lastPointsResetDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].lastPointsResetDate"]
set loyaltyMemberCurrencyName [CkJsonObject_stringOf $jResp "memberCurrencies[i].loyaltyMemberCurrencyName"]
set loyaltyProgramCurrencyId [CkJsonObject_stringOf $jResp "memberCurrencies[i].loyaltyProgramCurrencyId"]
set loyaltyProgramCurrencyName [CkJsonObject_stringOf $jResp "memberCurrencies[i].loyaltyProgramCurrencyName"]
set memberCurrencyId [CkJsonObject_stringOf $jResp "memberCurrencies[i].memberCurrencyId"]
set nextQualifyingPointsResetDate [CkJsonObject_stringOf $jResp "memberCurrencies[i].nextQualifyingPointsResetDate"]
set pointsBalance [CkJsonObject_IntOf $jResp "memberCurrencies[i].pointsBalance"]
set qualifyingPointsBalanceBeforeReset [CkJsonObject_IntOf $jResp "memberCurrencies[i].qualifyingPointsBalanceBeforeReset"]
set totalEscrowPointsAccrued [CkJsonObject_IntOf $jResp "memberCurrencies[i].totalEscrowPointsAccrued"]
set totalEscrowRolloverPoints [CkJsonObject_IntOf $jResp "memberCurrencies[i].totalEscrowRolloverPoints"]
set totalPointsAccrued [CkJsonObject_IntOf $jResp "memberCurrencies[i].totalPointsAccrued"]
set totalPointsExpired [CkJsonObject_IntOf $jResp "memberCurrencies[i].totalPointsExpired"]
set totalPointsRedeemed [CkJsonObject_IntOf $jResp "memberCurrencies[i].totalPointsRedeemed"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "memberTiers"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set areTierBenefitsAssigned [CkJsonObject_BoolOf $jResp "memberTiers[i].areTierBenefitsAssigned"]
set loyaltyMemberTierId [CkJsonObject_stringOf $jResp "memberTiers[i].loyaltyMemberTierId"]
set loyaltyMemberTierName [CkJsonObject_stringOf $jResp "memberTiers[i].loyaltyMemberTierName"]
set tierChangeReason [CkJsonObject_stringOf $jResp "memberTiers[i].tierChangeReason"]
set tierChangeReasonType [CkJsonObject_stringOf $jResp "memberTiers[i].tierChangeReasonType"]
set tierEffectiveDate [CkJsonObject_stringOf $jResp "memberTiers[i].tierEffectiveDate"]
set tierExpirationDate [CkJsonObject_stringOf $jResp "memberTiers[i].tierExpirationDate"]
set tierGroupId [CkJsonObject_stringOf $jResp "memberTiers[i].tierGroupId"]
set tierGroupName [CkJsonObject_stringOf $jResp "memberTiers[i].tierGroupName"]
set tierId [CkJsonObject_stringOf $jResp "memberTiers[i].tierId"]
set tierSequenceNumber [CkJsonObject_IntOf $jResp "memberTiers[i].tierSequenceNumber"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
