Promotion Web Service

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

Promotion

Click here for a complete list of operations.

ProductCodePromotionExtended

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

<?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>
    <ProductCodePromotionExtended xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <ProductCode>string</ProductCode>
      <LocationExternalReference>string</LocationExternalReference>
      <ProductExternalReference>string</ProductExternalReference>
    </ProductCodePromotionExtended>
  </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>
    <ProductCodePromotionExtendedResponse xmlns="LoyaltyPlatformWS">
      <ProductCodePromotionExtendedResult>
        <ReturnCode>int</ReturnCode>
        <AppTransactionId>int</AppTransactionId>
        <TransactionProfitValue>double</TransactionProfitValue>
        <TransactionBasePointValue>double</TransactionBasePointValue>
        <TransactionPointValue>double</TransactionPointValue>
        <MemberFirstName>string</MemberFirstName>
        <MemberLastName>string</MemberLastName>
        <MemberPointsEarned>double</MemberPointsEarned>
        <MemberPointsDeducted>double</MemberPointsDeducted>
        <MemberPointsUsed>double</MemberPointsUsed>
        <MemberPointsExpired>double</MemberPointsExpired>
        <MemberPointsAvailable>double</MemberPointsAvailable>
        <MemberPointsLocked>double</MemberPointsLocked>
      </ProductCodePromotionExtendedResult>
    </ProductCodePromotionExtendedResponse>
  </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/Promotion.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>
    <ProductCodePromotionExtended xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <ProductCode>string</ProductCode>
      <LocationExternalReference>string</LocationExternalReference>
      <ProductExternalReference>string</ProductExternalReference>
    </ProductCodePromotionExtended>
  </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>
    <ProductCodePromotionExtendedResponse xmlns="LoyaltyPlatformWS">
      <ProductCodePromotionExtendedResult>
        <ReturnCode>int</ReturnCode>
        <AppTransactionId>int</AppTransactionId>
        <TransactionProfitValue>double</TransactionProfitValue>
        <TransactionBasePointValue>double</TransactionBasePointValue>
        <TransactionPointValue>double</TransactionPointValue>
        <MemberFirstName>string</MemberFirstName>
        <MemberLastName>string</MemberLastName>
        <MemberPointsEarned>double</MemberPointsEarned>
        <MemberPointsDeducted>double</MemberPointsDeducted>
        <MemberPointsUsed>double</MemberPointsUsed>
        <MemberPointsExpired>double</MemberPointsExpired>
        <MemberPointsAvailable>double</MemberPointsAvailable>
        <MemberPointsLocked>double</MemberPointsLocked>
      </ProductCodePromotionExtendedResult>
    </ProductCodePromotionExtendedResponse>
  </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/Promotion.asmx/ProductCodePromotionExtended?WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&ProductCode=string&LocationExternalReference=string&ProductExternalReference=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"?>
<ProductCodePromotionExtendedReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <AppTransactionId>int</AppTransactionId>
  <TransactionProfitValue>double</TransactionProfitValue>
  <TransactionBasePointValue>double</TransactionBasePointValue>
  <TransactionPointValue>double</TransactionPointValue>
  <MemberFirstName>string</MemberFirstName>
  <MemberLastName>string</MemberLastName>
  <MemberPointsEarned>double</MemberPointsEarned>
  <MemberPointsDeducted>double</MemberPointsDeducted>
  <MemberPointsUsed>double</MemberPointsUsed>
  <MemberPointsExpired>double</MemberPointsExpired>
  <MemberPointsAvailable>double</MemberPointsAvailable>
  <MemberPointsLocked>double</MemberPointsLocked>
</ProductCodePromotionExtendedReturn>

HTTP POST

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

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

WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&ProductCode=string&LocationExternalReference=string&ProductExternalReference=string

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

<?xml version="1.0" encoding="utf-8"?>
<ProductCodePromotionExtendedReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <AppTransactionId>int</AppTransactionId>
  <TransactionProfitValue>double</TransactionProfitValue>
  <TransactionBasePointValue>double</TransactionBasePointValue>
  <TransactionPointValue>double</TransactionPointValue>
  <MemberFirstName>string</MemberFirstName>
  <MemberLastName>string</MemberLastName>
  <MemberPointsEarned>double</MemberPointsEarned>
  <MemberPointsDeducted>double</MemberPointsDeducted>
  <MemberPointsUsed>double</MemberPointsUsed>
  <MemberPointsExpired>double</MemberPointsExpired>
  <MemberPointsAvailable>double</MemberPointsAvailable>
  <MemberPointsLocked>double</MemberPointsLocked>
</ProductCodePromotionExtendedReturn>