Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Member Benefits

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcBenefitId
LOCAL lcBenefitName
LOCAL lcBenefitTypeId
LOCAL lcBenefitTypeName
LOCAL lcCreatedRecordId
LOCAL lcCreatedRecordName
LOCAL lcDescription
LOCAL lcEndDate
LOCAL lnIsActive
LOCAL lcMemberBenefitStatus
LOCAL lcStartDate
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

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

* {
*   "memberBenefits": [
*     {
*       "benefitId": "0jiJ80000008OIFIA2",
*       "benefitName": "Free Shipping",
*       "benefitTypeId": "0jhJ80000008OI5IAM",
*       "benefitTypeName": "Shipping",
*       "createdRecordId": null,
*       "createdRecordName": null,
*       "description": null,
*       "endDate": null,
*       "isActive": true,
*       "memberBenefitStatus": null,
*       "startDate": null
*     },
*     {
*       "benefitId": "0jiJ80000008OI5IAM",
*       "benefitName": "5% of Discount",
*       "benefitTypeId": "0jhJ80000008OIAIA2",
*       "benefitTypeName": "Discount Percentage",
*       "createdRecordId": null,
*       "createdRecordName": null,
*       "description": null,
*       "endDate": null,
*       "isActive": true,
*       "memberBenefitStatus": null,
*       "startDate": null
*     }
*   ]
* }

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

i = 0
lnCount_i = loJResp.SizeOfArray("memberBenefits")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcBenefitId = loJResp.StringOf("memberBenefits[i].benefitId")
    lcBenefitName = loJResp.StringOf("memberBenefits[i].benefitName")
    lcBenefitTypeId = loJResp.StringOf("memberBenefits[i].benefitTypeId")
    lcBenefitTypeName = loJResp.StringOf("memberBenefits[i].benefitTypeName")
    lcCreatedRecordId = loJResp.StringOf("memberBenefits[i].createdRecordId")
    lcCreatedRecordName = loJResp.StringOf("memberBenefits[i].createdRecordName")
    lcDescription = loJResp.StringOf("memberBenefits[i].description")
    lcEndDate = loJResp.StringOf("memberBenefits[i].endDate")
    lnIsActive = loJResp.BoolOf("memberBenefits[i].isActive")
    lcMemberBenefitStatus = loJResp.StringOf("memberBenefits[i].memberBenefitStatus")
    lcStartDate = loJResp.StringOf("memberBenefits[i].startDate")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits

Postman Collection Item JSON

{
  "name": "Member Benefits",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "connect",
        "loyalty",
        "member",
        ":memberId",
        "memberbenefits"
      ],
      "variable": [
        {
          "key": "memberId",
          "value": ""
        }
      ]
    },
    "description": "Standard Documentation:\n\n[https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_benefits.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_member_benefits.htm)"
  },
  "response": [
    {
      "name": "Member Benefits",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{accessToken}}"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "connect",
            "loyalty",
            "member",
            ":memberId",
            "memberbenefits"
          ],
          "variable": [
            {
              "key": "memberId",
              "value": "0lMJ8000000CaRMMA0"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 22 May 2024 16:11:06 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    \"memberBenefits\": [\n        {\n            \"benefitId\": \"0jiJ80000008OIFIA2\",\n            \"benefitName\": \"Free Shipping\",\n            \"benefitTypeId\": \"0jhJ80000008OI5IAM\",\n            \"benefitTypeName\": \"Shipping\",\n            \"createdRecordId\": null,\n            \"createdRecordName\": null,\n            \"description\": null,\n            \"endDate\": null,\n            \"isActive\": true,\n            \"memberBenefitStatus\": null,\n            \"startDate\": null\n        },\n        {\n            \"benefitId\": \"0jiJ80000008OI5IAM\",\n            \"benefitName\": \"5% of Discount\",\n            \"benefitTypeId\": \"0jhJ80000008OIAIA2\",\n            \"benefitTypeName\": \"Discount Percentage\",\n            \"createdRecordId\": null,\n            \"createdRecordName\": null,\n            \"description\": null,\n            \"endDate\": null,\n            \"isActive\": true,\n            \"memberBenefitStatus\": null,\n            \"startDate\": null\n        }\n    ]\n}"
    }
  ]
}