Offer Web Service

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

Offer

Click here for a complete list of operations.

IssueMultipleChoiceRewardsExtended

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 /WS/Offer.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LoyaltyPlatformWS/IssueMultipleChoiceRewardsExtended"

<?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>
    <IssueMultipleChoiceRewardsExtended xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <LocationExternalReference>string</LocationExternalReference>
      <RewardTypeExternalReference>string</RewardTypeExternalReference>
      <RewardQuantity>int</RewardQuantity>
      <TransferTargetExternalReference>string</TransferTargetExternalReference>
      <DeliveredStatus>int</DeliveredStatus>
      <RedeemedStatus>int</RedeemedStatus>
    </IssueMultipleChoiceRewardsExtended>
  </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>
    <IssueMultipleChoiceRewardsExtendedResponse xmlns="LoyaltyPlatformWS">
      <IssueMultipleChoiceRewardsExtendedResult>
        <ReturnCode>int</ReturnCode>
        <Rewards>
          <IssueMultipleChoiceRewardsItem>
            <ReturnCode>int</ReturnCode>
            <MemberRewardId>int</MemberRewardId>
            <RewardName>string</RewardName>
            <RewardPointCost>double</RewardPointCost>
            <RewardValue>double</RewardValue>
            <RewardBarcode>string</RewardBarcode>
            <RewardBarcodePIN>string</RewardBarcodePIN>
            <RewardViewURL>string</RewardViewURL>
            <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
            <RewardViewSecurityCode>string</RewardViewSecurityCode>
            <ExpireEndOfDay>string</ExpireEndOfDay>
          </IssueMultipleChoiceRewardsItem>
          <IssueMultipleChoiceRewardsItem>
            <ReturnCode>int</ReturnCode>
            <MemberRewardId>int</MemberRewardId>
            <RewardName>string</RewardName>
            <RewardPointCost>double</RewardPointCost>
            <RewardValue>double</RewardValue>
            <RewardBarcode>string</RewardBarcode>
            <RewardBarcodePIN>string</RewardBarcodePIN>
            <RewardViewURL>string</RewardViewURL>
            <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
            <RewardViewSecurityCode>string</RewardViewSecurityCode>
            <ExpireEndOfDay>string</ExpireEndOfDay>
          </IssueMultipleChoiceRewardsItem>
        </Rewards>
      </IssueMultipleChoiceRewardsExtendedResult>
    </IssueMultipleChoiceRewardsExtendedResponse>
  </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 /WS/Offer.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>
    <IssueMultipleChoiceRewardsExtended xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <LocationExternalReference>string</LocationExternalReference>
      <RewardTypeExternalReference>string</RewardTypeExternalReference>
      <RewardQuantity>int</RewardQuantity>
      <TransferTargetExternalReference>string</TransferTargetExternalReference>
      <DeliveredStatus>int</DeliveredStatus>
      <RedeemedStatus>int</RedeemedStatus>
    </IssueMultipleChoiceRewardsExtended>
  </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>
    <IssueMultipleChoiceRewardsExtendedResponse xmlns="LoyaltyPlatformWS">
      <IssueMultipleChoiceRewardsExtendedResult>
        <ReturnCode>int</ReturnCode>
        <Rewards>
          <IssueMultipleChoiceRewardsItem>
            <ReturnCode>int</ReturnCode>
            <MemberRewardId>int</MemberRewardId>
            <RewardName>string</RewardName>
            <RewardPointCost>double</RewardPointCost>
            <RewardValue>double</RewardValue>
            <RewardBarcode>string</RewardBarcode>
            <RewardBarcodePIN>string</RewardBarcodePIN>
            <RewardViewURL>string</RewardViewURL>
            <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
            <RewardViewSecurityCode>string</RewardViewSecurityCode>
            <ExpireEndOfDay>string</ExpireEndOfDay>
          </IssueMultipleChoiceRewardsItem>
          <IssueMultipleChoiceRewardsItem>
            <ReturnCode>int</ReturnCode>
            <MemberRewardId>int</MemberRewardId>
            <RewardName>string</RewardName>
            <RewardPointCost>double</RewardPointCost>
            <RewardValue>double</RewardValue>
            <RewardBarcode>string</RewardBarcode>
            <RewardBarcodePIN>string</RewardBarcodePIN>
            <RewardViewURL>string</RewardViewURL>
            <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
            <RewardViewSecurityCode>string</RewardViewSecurityCode>
            <ExpireEndOfDay>string</ExpireEndOfDay>
          </IssueMultipleChoiceRewardsItem>
        </Rewards>
      </IssueMultipleChoiceRewardsExtendedResult>
    </IssueMultipleChoiceRewardsExtendedResponse>
  </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 /WS/Offer.asmx/IssueMultipleChoiceRewardsExtended?WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&LocationExternalReference=string&RewardTypeExternalReference=string&RewardQuantity=string&TransferTargetExternalReference=string&DeliveredStatus=string&RedeemedStatus=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"?>
<IssueMultipleChoiceRewardsReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <Rewards>
    <IssueMultipleChoiceRewardsItem>
      <ReturnCode>int</ReturnCode>
      <MemberRewardId>int</MemberRewardId>
      <RewardName>string</RewardName>
      <RewardPointCost>double</RewardPointCost>
      <RewardValue>double</RewardValue>
      <RewardBarcode>string</RewardBarcode>
      <RewardBarcodePIN>string</RewardBarcodePIN>
      <RewardViewURL>string</RewardViewURL>
      <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
      <RewardViewSecurityCode>string</RewardViewSecurityCode>
      <ExpireEndOfDay>string</ExpireEndOfDay>
    </IssueMultipleChoiceRewardsItem>
    <IssueMultipleChoiceRewardsItem>
      <ReturnCode>int</ReturnCode>
      <MemberRewardId>int</MemberRewardId>
      <RewardName>string</RewardName>
      <RewardPointCost>double</RewardPointCost>
      <RewardValue>double</RewardValue>
      <RewardBarcode>string</RewardBarcode>
      <RewardBarcodePIN>string</RewardBarcodePIN>
      <RewardViewURL>string</RewardViewURL>
      <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
      <RewardViewSecurityCode>string</RewardViewSecurityCode>
      <ExpireEndOfDay>string</ExpireEndOfDay>
    </IssueMultipleChoiceRewardsItem>
  </Rewards>
</IssueMultipleChoiceRewardsReturn>

HTTP POST

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

POST /WS/Offer.asmx/IssueMultipleChoiceRewardsExtended HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&LocationExternalReference=string&RewardTypeExternalReference=string&RewardQuantity=string&TransferTargetExternalReference=string&DeliveredStatus=string&RedeemedStatus=string

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

<?xml version="1.0" encoding="utf-8"?>
<IssueMultipleChoiceRewardsReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <Rewards>
    <IssueMultipleChoiceRewardsItem>
      <ReturnCode>int</ReturnCode>
      <MemberRewardId>int</MemberRewardId>
      <RewardName>string</RewardName>
      <RewardPointCost>double</RewardPointCost>
      <RewardValue>double</RewardValue>
      <RewardBarcode>string</RewardBarcode>
      <RewardBarcodePIN>string</RewardBarcodePIN>
      <RewardViewURL>string</RewardViewURL>
      <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
      <RewardViewSecurityCode>string</RewardViewSecurityCode>
      <ExpireEndOfDay>string</ExpireEndOfDay>
    </IssueMultipleChoiceRewardsItem>
    <IssueMultipleChoiceRewardsItem>
      <ReturnCode>int</ReturnCode>
      <MemberRewardId>int</MemberRewardId>
      <RewardName>string</RewardName>
      <RewardPointCost>double</RewardPointCost>
      <RewardValue>double</RewardValue>
      <RewardBarcode>string</RewardBarcode>
      <RewardBarcodePIN>string</RewardBarcodePIN>
      <RewardViewURL>string</RewardViewURL>
      <RewardViewURLNoSecurityCode>string</RewardViewURLNoSecurityCode>
      <RewardViewSecurityCode>string</RewardViewSecurityCode>
      <ExpireEndOfDay>string</ExpireEndOfDay>
    </IssueMultipleChoiceRewardsItem>
  </Rewards>
</IssueMultipleChoiceRewardsReturn>