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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"memberId","")
CkJsonObject::ckUpdateString(queryParams,"membershipNumber","")
CkJsonObject::ckUpdateString(queryParams,"programCurrencyName","")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/loyalty-programs/:loyaltyProgramName/members",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
Level_Before_Reset__c.s
escrowPointsBalance.i
expirablePoints.i
lastAccrualProcessedDate.s
lastEscrowProcessedDate.s
lastExpirationProcessRunDate.s
lastPointsAggregationDate.s
lastPointsResetDate.s
loyaltyMemberCurrencyName.s
loyaltyProgramCurrencyId.s
loyaltyProgramCurrencyName.s
memberCurrencyId.s
nextQualifyingPointsResetDate.s
pointsBalance.i
qualifyingPointsBalanceBeforeReset.i
totalEscrowPointsAccrued.i
totalEscrowRolloverPoints.i
totalPointsAccrued.i
totalPointsExpired.i
totalPointsRedeemed.i
areTierBenefitsAssigned.i
loyaltyMemberTierId.s
loyaltyMemberTierName.s
tierChangeReason.s
tierChangeReasonType.s
tierEffectiveDate.s
tierExpirationDate.s
tierGroupId.s
tierGroupName.s
tierId.s
tierSequenceNumber.i
associatedAccount.s = CkJsonObject::ckStringOf(jResp,"associatedAccount")
ContactId.s = CkJsonObject::ckStringOf(jResp,"associatedContact.contactId")
v_Email.s = CkJsonObject::ckStringOf(jResp,"associatedContact.email")
FirstName.s = CkJsonObject::ckStringOf(jResp,"associatedContact.firstName")
LastName.s = CkJsonObject::ckStringOf(jResp,"associatedContact.lastName")
canReceivePartnerPromotions.i = CkJsonObject::ckBoolOf(jResp,"canReceivePartnerPromotions")
canReceivePromotions.i = CkJsonObject::ckBoolOf(jResp,"canReceivePromotions")
enrollmentChannel.s = CkJsonObject::ckStringOf(jResp,"enrollmentChannel")
enrollmentDate.s = CkJsonObject::ckStringOf(jResp,"enrollmentDate")
groupCreatedByMember.s = CkJsonObject::ckStringOf(jResp,"groupCreatedByMember")
groupName.s = CkJsonObject::ckStringOf(jResp,"groupName")
lastActivityDate.s = CkJsonObject::ckStringOf(jResp,"lastActivityDate")
loyaltyProgramMemberId.s = CkJsonObject::ckStringOf(jResp,"loyaltyProgramMemberId")
loyaltyProgramName.s = CkJsonObject::ckStringOf(jResp,"loyaltyProgramName")
memberStatus.s = CkJsonObject::ckStringOf(jResp,"memberStatus")
memberType.s = CkJsonObject::ckStringOf(jResp,"memberType")
membershipEndDate.s = CkJsonObject::ckStringOf(jResp,"membershipEndDate")
membershipLastRenewalDate.s = CkJsonObject::ckStringOf(jResp,"membershipLastRenewalDate")
membershipNumber.s = CkJsonObject::ckStringOf(jResp,"membershipNumber")
referredBy.s = CkJsonObject::ckStringOf(jResp,"referredBy")
relatedCorporateMembershipNumber.s = CkJsonObject::ckStringOf(jResp,"relatedCorporateMembershipNumber")
transactionJournalStatementFrequency.s = CkJsonObject::ckStringOf(jResp,"transactionJournalStatementFrequency")
transactionJournalStatementLastGeneratedDate.s = CkJsonObject::ckStringOf(jResp,"transactionJournalStatementLastGeneratedDate")
transactionJournalStatementMethod.s = CkJsonObject::ckStringOf(jResp,"transactionJournalStatementMethod")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"memberCurrencies")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Level_Before_Reset__c = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].additionalLoyaltyMemberCurrencyFields.Level_Before_Reset__c")
escrowPointsBalance = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].escrowPointsBalance")
expirablePoints = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].expirablePoints")
lastAccrualProcessedDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].lastAccrualProcessedDate")
lastEscrowProcessedDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].lastEscrowProcessedDate")
lastExpirationProcessRunDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].lastExpirationProcessRunDate")
lastPointsAggregationDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].lastPointsAggregationDate")
lastPointsResetDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].lastPointsResetDate")
loyaltyMemberCurrencyName = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].loyaltyMemberCurrencyName")
loyaltyProgramCurrencyId = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].loyaltyProgramCurrencyId")
loyaltyProgramCurrencyName = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].loyaltyProgramCurrencyName")
memberCurrencyId = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].memberCurrencyId")
nextQualifyingPointsResetDate = CkJsonObject::ckStringOf(jResp,"memberCurrencies[i].nextQualifyingPointsResetDate")
pointsBalance = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].pointsBalance")
qualifyingPointsBalanceBeforeReset = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].qualifyingPointsBalanceBeforeReset")
totalEscrowPointsAccrued = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].totalEscrowPointsAccrued")
totalEscrowRolloverPoints = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].totalEscrowRolloverPoints")
totalPointsAccrued = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].totalPointsAccrued")
totalPointsExpired = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].totalPointsExpired")
totalPointsRedeemed = CkJsonObject::ckIntOf(jResp,"memberCurrencies[i].totalPointsRedeemed")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"memberTiers")
While i < count_i
CkJsonObject::setCkI(jResp, i)
areTierBenefitsAssigned = CkJsonObject::ckBoolOf(jResp,"memberTiers[i].areTierBenefitsAssigned")
loyaltyMemberTierId = CkJsonObject::ckStringOf(jResp,"memberTiers[i].loyaltyMemberTierId")
loyaltyMemberTierName = CkJsonObject::ckStringOf(jResp,"memberTiers[i].loyaltyMemberTierName")
tierChangeReason = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierChangeReason")
tierChangeReasonType = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierChangeReasonType")
tierEffectiveDate = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierEffectiveDate")
tierExpirationDate = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierExpirationDate")
tierGroupId = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierGroupId")
tierGroupName = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierGroupName")
tierId = CkJsonObject::ckStringOf(jResp,"memberTiers[i].tierId")
tierSequenceNumber = CkJsonObject::ckIntOf(jResp,"memberTiers[i].tierSequenceNumber")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
