Chilkat Online Tools

TCL / Salesforce Platform APIs / Member Benefits

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]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "memberBenefits"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set benefitId [CkJsonObject_stringOf $jResp "memberBenefits[i].benefitId"]
    set benefitName [CkJsonObject_stringOf $jResp "memberBenefits[i].benefitName"]
    set benefitTypeId [CkJsonObject_stringOf $jResp "memberBenefits[i].benefitTypeId"]
    set benefitTypeName [CkJsonObject_stringOf $jResp "memberBenefits[i].benefitTypeName"]
    set createdRecordId [CkJsonObject_stringOf $jResp "memberBenefits[i].createdRecordId"]
    set createdRecordName [CkJsonObject_stringOf $jResp "memberBenefits[i].createdRecordName"]
    set description [CkJsonObject_stringOf $jResp "memberBenefits[i].description"]
    set endDate [CkJsonObject_stringOf $jResp "memberBenefits[i].endDate"]
    set isActive [CkJsonObject_BoolOf $jResp "memberBenefits[i].isActive"]
    set memberBenefitStatus [CkJsonObject_stringOf $jResp "memberBenefits[i].memberBenefitStatus"]
    set startDate [CkJsonObject_stringOf $jResp "memberBenefits[i].startDate"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}