Reward Web Service

Kognitiv
130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2

Reward

Click here for a complete list of operations.

MemberIssuedRewardsSetExt

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/Reward.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://app.smartbutton.com/Services/MemberIssuedRewardsSetExt"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MemberIssuedRewardsSetExt xmlns="https://app.smartbutton.com/Services/">
      <SecurityToken>string</SecurityToken>
      <LoyaltyProgramId>int</LoyaltyProgramId>
      <AccountId>string</AccountId>
    </MemberIssuedRewardsSetExt>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <MemberIssuedRewardsSetExtResponse xmlns="https://app.smartbutton.com/Services/">
      <MemberIssuedRewardsSetExtResult>
        <ReturnCode>int</ReturnCode>
        <MemberIssuedRewards>
          <MemberIssuedRewardsSetItemExt>
            <RewardId>int</RewardId>
            <RewardName>string</RewardName>
            <RewardTypeExternalRef>string</RewardTypeExternalRef>
            <LocationName>string</LocationName>
            <RewardPointValue>double</RewardPointValue>
            <RewardValue>double</RewardValue>
            <IssueTimestamp>string</IssueTimestamp>
            <PrintTimestamp>string</PrintTimestamp>
            <RewardStatus>string</RewardStatus>
            <RedeemTimestamp>string</RedeemTimestamp>
            <RedeemLocationName>string</RedeemLocationName>
            <ExpireTimestamp>string</ExpireTimestamp>
            <RewardBarcode>string</RewardBarcode>
            <RewardPIN>string</RewardPIN>
          </MemberIssuedRewardsSetItemExt>
          <MemberIssuedRewardsSetItemExt>
            <RewardId>int</RewardId>
            <RewardName>string</RewardName>
            <RewardTypeExternalRef>string</RewardTypeExternalRef>
            <LocationName>string</LocationName>
            <RewardPointValue>double</RewardPointValue>
            <RewardValue>double</RewardValue>
            <IssueTimestamp>string</IssueTimestamp>
            <PrintTimestamp>string</PrintTimestamp>
            <RewardStatus>string</RewardStatus>
            <RedeemTimestamp>string</RedeemTimestamp>
            <RedeemLocationName>string</RedeemLocationName>
            <ExpireTimestamp>string</ExpireTimestamp>
            <RewardBarcode>string</RewardBarcode>
            <RewardPIN>string</RewardPIN>
          </MemberIssuedRewardsSetItemExt>
        </MemberIssuedRewards>
      </MemberIssuedRewardsSetExtResult>
    </MemberIssuedRewardsSetExtResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/Reward.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MemberIssuedRewardsSetExt xmlns="https://app.smartbutton.com/Services/">
      <SecurityToken>string</SecurityToken>
      <LoyaltyProgramId>int</LoyaltyProgramId>
      <AccountId>string</AccountId>
    </MemberIssuedRewardsSetExt>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <MemberIssuedRewardsSetExtResponse xmlns="https://app.smartbutton.com/Services/">
      <MemberIssuedRewardsSetExtResult>
        <ReturnCode>int</ReturnCode>
        <MemberIssuedRewards>
          <MemberIssuedRewardsSetItemExt>
            <RewardId>int</RewardId>
            <RewardName>string</RewardName>
            <RewardTypeExternalRef>string</RewardTypeExternalRef>
            <LocationName>string</LocationName>
            <RewardPointValue>double</RewardPointValue>
            <RewardValue>double</RewardValue>
            <IssueTimestamp>string</IssueTimestamp>
            <PrintTimestamp>string</PrintTimestamp>
            <RewardStatus>string</RewardStatus>
            <RedeemTimestamp>string</RedeemTimestamp>
            <RedeemLocationName>string</RedeemLocationName>
            <ExpireTimestamp>string</ExpireTimestamp>
            <RewardBarcode>string</RewardBarcode>
            <RewardPIN>string</RewardPIN>
          </MemberIssuedRewardsSetItemExt>
          <MemberIssuedRewardsSetItemExt>
            <RewardId>int</RewardId>
            <RewardName>string</RewardName>
            <RewardTypeExternalRef>string</RewardTypeExternalRef>
            <LocationName>string</LocationName>
            <RewardPointValue>double</RewardPointValue>
            <RewardValue>double</RewardValue>
            <IssueTimestamp>string</IssueTimestamp>
            <PrintTimestamp>string</PrintTimestamp>
            <RewardStatus>string</RewardStatus>
            <RedeemTimestamp>string</RedeemTimestamp>
            <RedeemLocationName>string</RedeemLocationName>
            <ExpireTimestamp>string</ExpireTimestamp>
            <RewardBarcode>string</RewardBarcode>
            <RewardPIN>string</RewardPIN>
          </MemberIssuedRewardsSetItemExt>
        </MemberIssuedRewards>
      </MemberIssuedRewardsSetExtResult>
    </MemberIssuedRewardsSetExtResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Services/Reward.asmx/MemberIssuedRewardsSetExt?SecurityToken=string&LoyaltyProgramId=string&AccountId=string HTTP/1.1
Host: app.kognitivloyalty.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<respMemberIssuedRewardsSetExt xmlns="https://app.smartbutton.com/Services/">
  <ReturnCode>int</ReturnCode>
  <MemberIssuedRewards>
    <MemberIssuedRewardsSetItemExt>
      <RewardId>int</RewardId>
      <RewardName>string</RewardName>
      <RewardTypeExternalRef>string</RewardTypeExternalRef>
      <LocationName>string</LocationName>
      <RewardPointValue>double</RewardPointValue>
      <RewardValue>double</RewardValue>
      <IssueTimestamp>string</IssueTimestamp>
      <PrintTimestamp>string</PrintTimestamp>
      <RewardStatus>string</RewardStatus>
      <RedeemTimestamp>string</RedeemTimestamp>
      <RedeemLocationName>string</RedeemLocationName>
      <ExpireTimestamp>string</ExpireTimestamp>
      <RewardBarcode>string</RewardBarcode>
      <RewardPIN>string</RewardPIN>
    </MemberIssuedRewardsSetItemExt>
    <MemberIssuedRewardsSetItemExt>
      <RewardId>int</RewardId>
      <RewardName>string</RewardName>
      <RewardTypeExternalRef>string</RewardTypeExternalRef>
      <LocationName>string</LocationName>
      <RewardPointValue>double</RewardPointValue>
      <RewardValue>double</RewardValue>
      <IssueTimestamp>string</IssueTimestamp>
      <PrintTimestamp>string</PrintTimestamp>
      <RewardStatus>string</RewardStatus>
      <RedeemTimestamp>string</RedeemTimestamp>
      <RedeemLocationName>string</RedeemLocationName>
      <ExpireTimestamp>string</ExpireTimestamp>
      <RewardBarcode>string</RewardBarcode>
      <RewardPIN>string</RewardPIN>
    </MemberIssuedRewardsSetItemExt>
  </MemberIssuedRewards>
</respMemberIssuedRewardsSetExt>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Services/Reward.asmx/MemberIssuedRewardsSetExt HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SecurityToken=string&LoyaltyProgramId=string&AccountId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<respMemberIssuedRewardsSetExt xmlns="https://app.smartbutton.com/Services/">
  <ReturnCode>int</ReturnCode>
  <MemberIssuedRewards>
    <MemberIssuedRewardsSetItemExt>
      <RewardId>int</RewardId>
      <RewardName>string</RewardName>
      <RewardTypeExternalRef>string</RewardTypeExternalRef>
      <LocationName>string</LocationName>
      <RewardPointValue>double</RewardPointValue>
      <RewardValue>double</RewardValue>
      <IssueTimestamp>string</IssueTimestamp>
      <PrintTimestamp>string</PrintTimestamp>
      <RewardStatus>string</RewardStatus>
      <RedeemTimestamp>string</RedeemTimestamp>
      <RedeemLocationName>string</RedeemLocationName>
      <ExpireTimestamp>string</ExpireTimestamp>
      <RewardBarcode>string</RewardBarcode>
      <RewardPIN>string</RewardPIN>
    </MemberIssuedRewardsSetItemExt>
    <MemberIssuedRewardsSetItemExt>
      <RewardId>int</RewardId>
      <RewardName>string</RewardName>
      <RewardTypeExternalRef>string</RewardTypeExternalRef>
      <LocationName>string</LocationName>
      <RewardPointValue>double</RewardPointValue>
      <RewardValue>double</RewardValue>
      <IssueTimestamp>string</IssueTimestamp>
      <PrintTimestamp>string</PrintTimestamp>
      <RewardStatus>string</RewardStatus>
      <RedeemTimestamp>string</RedeemTimestamp>
      <RedeemLocationName>string</RedeemLocationName>
      <ExpireTimestamp>string</ExpireTimestamp>
      <RewardBarcode>string</RewardBarcode>
      <RewardPIN>string</RewardPIN>
    </MemberIssuedRewardsSetItemExt>
  </MemberIssuedRewards>
</respMemberIssuedRewardsSetExt>