SAPInterfaceExtension Web Service

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

SAPInterfaceExtension

Click here for a complete list of operations.

ReturnOfferCodes

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/v2/SAPInterface.asmx HTTP/1.1
Host: app.kognitivloyalty.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://app.smartbutton.com/Services/ReturnOfferCodes"

<?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>
    <ReturnOfferCodes xmlns="https://app.smartbutton.com/Services/">
      <psSecurityToken>string</psSecurityToken>
      <psTransactionUniqueId>string</psTransactionUniqueId>
      <pdTransactionAmount>double</pdTransactionAmount>
    </ReturnOfferCodes>
  </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>
    <ReturnOfferCodesResponse xmlns="https://app.smartbutton.com/Services/">
      <ReturnOfferCodesResult>
        <ReturnCode>int</ReturnCode>
        <ReturnDescription>string</ReturnDescription>
        <MemberId>int</MemberId>
        <RewardOfferCodes>
          <string>string</string>
          <string>string</string>
        </RewardOfferCodes>
        <CouponOfferCodes>
          <string>string</string>
          <string>string</string>
        </CouponOfferCodes>
        <SmartButtonTransactionId>long</SmartButtonTransactionId>
        <PointsEarnedForTransaction>double</PointsEarnedForTransaction>
        <TotalPointsAvailable>double</TotalPointsAvailable>
        <PrimaryAccountId>string</PrimaryAccountId>
        <Message>string</Message>
      </ReturnOfferCodesResult>
    </ReturnOfferCodesResponse>
  </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/v2/SAPInterface.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>
    <ReturnOfferCodes xmlns="https://app.smartbutton.com/Services/">
      <psSecurityToken>string</psSecurityToken>
      <psTransactionUniqueId>string</psTransactionUniqueId>
      <pdTransactionAmount>double</pdTransactionAmount>
    </ReturnOfferCodes>
  </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>
    <ReturnOfferCodesResponse xmlns="https://app.smartbutton.com/Services/">
      <ReturnOfferCodesResult>
        <ReturnCode>int</ReturnCode>
        <ReturnDescription>string</ReturnDescription>
        <MemberId>int</MemberId>
        <RewardOfferCodes>
          <string>string</string>
          <string>string</string>
        </RewardOfferCodes>
        <CouponOfferCodes>
          <string>string</string>
          <string>string</string>
        </CouponOfferCodes>
        <SmartButtonTransactionId>long</SmartButtonTransactionId>
        <PointsEarnedForTransaction>double</PointsEarnedForTransaction>
        <TotalPointsAvailable>double</TotalPointsAvailable>
        <PrimaryAccountId>string</PrimaryAccountId>
        <Message>string</Message>
      </ReturnOfferCodesResult>
    </ReturnOfferCodesResponse>
  </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/v2/SAPInterface.asmx/ReturnOfferCodes?psSecurityToken=string&psTransactionUniqueId=string&pdTransactionAmount=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"?>
<respReturnOfferCodesExtI xmlns="https://app.smartbutton.com/Services/">
  <ReturnCode>int</ReturnCode>
  <ReturnDescription>string</ReturnDescription>
  <MemberId>int</MemberId>
  <RewardOfferCodes>
    <string>string</string>
    <string>string</string>
  </RewardOfferCodes>
  <CouponOfferCodes>
    <string>string</string>
    <string>string</string>
  </CouponOfferCodes>
  <SmartButtonTransactionId>long</SmartButtonTransactionId>
  <PointsEarnedForTransaction>double</PointsEarnedForTransaction>
  <TotalPointsAvailable>double</TotalPointsAvailable>
  <PrimaryAccountId>string</PrimaryAccountId>
  <Message>string</Message>
</respReturnOfferCodesExtI>

HTTP POST

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

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

psSecurityToken=string&psTransactionUniqueId=string&pdTransactionAmount=string

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

<?xml version="1.0" encoding="utf-8"?>
<respReturnOfferCodesExtI xmlns="https://app.smartbutton.com/Services/">
  <ReturnCode>int</ReturnCode>
  <ReturnDescription>string</ReturnDescription>
  <MemberId>int</MemberId>
  <RewardOfferCodes>
    <string>string</string>
    <string>string</string>
  </RewardOfferCodes>
  <CouponOfferCodes>
    <string>string</string>
    <string>string</string>
  </CouponOfferCodes>
  <SmartButtonTransactionId>long</SmartButtonTransactionId>
  <PointsEarnedForTransaction>double</PointsEarnedForTransaction>
  <TotalPointsAvailable>double</TotalPointsAvailable>
  <PrimaryAccountId>string</PrimaryAccountId>
  <Message>string</Message>
</respReturnOfferCodesExtI>