Chilkat Online Tools

phpAx / Salesforce Platform APIs / Member Benefits

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/services/data/v{{version}}/connect/loyalty/member/:memberId/memberbenefits',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    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

$i = 0;
$count_i = $jResp->SizeOfArray('memberBenefits');
while ($i < $count_i) {
    $jResp->I = $i;
    $benefitId = $jResp->stringOf('memberBenefits[i].benefitId');
    $benefitName = $jResp->stringOf('memberBenefits[i].benefitName');
    $benefitTypeId = $jResp->stringOf('memberBenefits[i].benefitTypeId');
    $benefitTypeName = $jResp->stringOf('memberBenefits[i].benefitTypeName');
    $createdRecordId = $jResp->stringOf('memberBenefits[i].createdRecordId');
    $createdRecordName = $jResp->stringOf('memberBenefits[i].createdRecordName');
    $description = $jResp->stringOf('memberBenefits[i].description');
    $endDate = $jResp->stringOf('memberBenefits[i].endDate');
    $isActive = $jResp->BoolOf('memberBenefits[i].isActive');
    $memberBenefitStatus = $jResp->stringOf('memberBenefits[i].memberBenefitStatus');
    $startDate = $jResp->stringOf('memberBenefits[i].startDate');
    $i = $i + 1;
}


?>

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