TOPYXAPI Web Service

TOPYXAPI

Click here for a complete list of operations.

AddCoupons

Possible values for CouponTypeIdentifier = [single,multiple,bulk]

Test

The test form is only available for requests from the local machine.

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 /topyxapi.asmx HTTP/1.1
Host: api2.interactyx.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/AddCoupons"

<?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>
    <AddCoupons xmlns="http://tempuri.org/">
      <token>string</token>
      <coupons>
        <Coupon>
          <Code>string</Code>
          <Name>string</Name>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DiscountPercentage>short</DiscountPercentage>
          <DiscountType>int</DiscountType>
          <CouponTypeIdentifier>string</CouponTypeIdentifier>
          <DiscountOn>int</DiscountOn>
          <StartNumber>int</StartNumber>
          <EndNumber>int</EndNumber>
          <SelectedCourse>
            <int>int</int>
            <int>int</int>
          </SelectedCourse>
          <SelectedTitle>
            <int>int</int>
            <int>int</int>
          </SelectedTitle>
          <SelectedProgram>
            <int>int</int>
            <int>int</int>
          </SelectedProgram>
          <SelectedSubscription>
            <int>int</int>
            <int>int</int>
          </SelectedSubscription>
          <SelectedUserGroups>
            <int>int</int>
            <int>int</int>
          </SelectedUserGroups>
          <DiscountCurrencyList>
            <DiscountCurrency xsi:nil="true" />
            <DiscountCurrency xsi:nil="true" />
          </DiscountCurrencyList>
          <DiscountPercentageForOneItem>int</DiscountPercentageForOneItem>
          <DiscountPercentageForTwoItem>int</DiscountPercentageForTwoItem>
          <DiscountPercentageForThreeItem>int</DiscountPercentageForThreeItem>
          <DiscountPercentageForFourItem>int</DiscountPercentageForFourItem>
          <DiscountPercentageForMoreThenFourItem>int</DiscountPercentageForMoreThenFourItem>
          <DiscountFirstPriceSubscription>int</DiscountFirstPriceSubscription>
          <DiscountEachPriceSubscription>int</DiscountEachPriceSubscription>
          <AddFuturePublishedPrograms>boolean</AddFuturePublishedPrograms>
          <AddFuturePublishedCourses>boolean</AddFuturePublishedCourses>
          <AddFuturePublishedMaterials>boolean</AddFuturePublishedMaterials>
        </Coupon>
        <Coupon>
          <Code>string</Code>
          <Name>string</Name>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DiscountPercentage>short</DiscountPercentage>
          <DiscountType>int</DiscountType>
          <CouponTypeIdentifier>string</CouponTypeIdentifier>
          <DiscountOn>int</DiscountOn>
          <StartNumber>int</StartNumber>
          <EndNumber>int</EndNumber>
          <SelectedCourse>
            <int>int</int>
            <int>int</int>
          </SelectedCourse>
          <SelectedTitle>
            <int>int</int>
            <int>int</int>
          </SelectedTitle>
          <SelectedProgram>
            <int>int</int>
            <int>int</int>
          </SelectedProgram>
          <SelectedSubscription>
            <int>int</int>
            <int>int</int>
          </SelectedSubscription>
          <SelectedUserGroups>
            <int>int</int>
            <int>int</int>
          </SelectedUserGroups>
          <DiscountCurrencyList>
            <DiscountCurrency xsi:nil="true" />
            <DiscountCurrency xsi:nil="true" />
          </DiscountCurrencyList>
          <DiscountPercentageForOneItem>int</DiscountPercentageForOneItem>
          <DiscountPercentageForTwoItem>int</DiscountPercentageForTwoItem>
          <DiscountPercentageForThreeItem>int</DiscountPercentageForThreeItem>
          <DiscountPercentageForFourItem>int</DiscountPercentageForFourItem>
          <DiscountPercentageForMoreThenFourItem>int</DiscountPercentageForMoreThenFourItem>
          <DiscountFirstPriceSubscription>int</DiscountFirstPriceSubscription>
          <DiscountEachPriceSubscription>int</DiscountEachPriceSubscription>
          <AddFuturePublishedPrograms>boolean</AddFuturePublishedPrograms>
          <AddFuturePublishedCourses>boolean</AddFuturePublishedCourses>
          <AddFuturePublishedMaterials>boolean</AddFuturePublishedMaterials>
        </Coupon>
      </coupons>
    </AddCoupons>
  </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>
    <AddCouponsResponse xmlns="http://tempuri.org/">
      <AddCouponsResult>
        <string>string</string>
        <string>string</string>
      </AddCouponsResult>
    </AddCouponsResponse>
  </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 /topyxapi.asmx HTTP/1.1
Host: api2.interactyx.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>
    <AddCoupons xmlns="http://tempuri.org/">
      <token>string</token>
      <coupons>
        <Coupon>
          <Code>string</Code>
          <Name>string</Name>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DiscountPercentage>short</DiscountPercentage>
          <DiscountType>int</DiscountType>
          <CouponTypeIdentifier>string</CouponTypeIdentifier>
          <DiscountOn>int</DiscountOn>
          <StartNumber>int</StartNumber>
          <EndNumber>int</EndNumber>
          <SelectedCourse>
            <int>int</int>
            <int>int</int>
          </SelectedCourse>
          <SelectedTitle>
            <int>int</int>
            <int>int</int>
          </SelectedTitle>
          <SelectedProgram>
            <int>int</int>
            <int>int</int>
          </SelectedProgram>
          <SelectedSubscription>
            <int>int</int>
            <int>int</int>
          </SelectedSubscription>
          <SelectedUserGroups>
            <int>int</int>
            <int>int</int>
          </SelectedUserGroups>
          <DiscountCurrencyList>
            <DiscountCurrency xsi:nil="true" />
            <DiscountCurrency xsi:nil="true" />
          </DiscountCurrencyList>
          <DiscountPercentageForOneItem>int</DiscountPercentageForOneItem>
          <DiscountPercentageForTwoItem>int</DiscountPercentageForTwoItem>
          <DiscountPercentageForThreeItem>int</DiscountPercentageForThreeItem>
          <DiscountPercentageForFourItem>int</DiscountPercentageForFourItem>
          <DiscountPercentageForMoreThenFourItem>int</DiscountPercentageForMoreThenFourItem>
          <DiscountFirstPriceSubscription>int</DiscountFirstPriceSubscription>
          <DiscountEachPriceSubscription>int</DiscountEachPriceSubscription>
          <AddFuturePublishedPrograms>boolean</AddFuturePublishedPrograms>
          <AddFuturePublishedCourses>boolean</AddFuturePublishedCourses>
          <AddFuturePublishedMaterials>boolean</AddFuturePublishedMaterials>
        </Coupon>
        <Coupon>
          <Code>string</Code>
          <Name>string</Name>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DiscountPercentage>short</DiscountPercentage>
          <DiscountType>int</DiscountType>
          <CouponTypeIdentifier>string</CouponTypeIdentifier>
          <DiscountOn>int</DiscountOn>
          <StartNumber>int</StartNumber>
          <EndNumber>int</EndNumber>
          <SelectedCourse>
            <int>int</int>
            <int>int</int>
          </SelectedCourse>
          <SelectedTitle>
            <int>int</int>
            <int>int</int>
          </SelectedTitle>
          <SelectedProgram>
            <int>int</int>
            <int>int</int>
          </SelectedProgram>
          <SelectedSubscription>
            <int>int</int>
            <int>int</int>
          </SelectedSubscription>
          <SelectedUserGroups>
            <int>int</int>
            <int>int</int>
          </SelectedUserGroups>
          <DiscountCurrencyList>
            <DiscountCurrency xsi:nil="true" />
            <DiscountCurrency xsi:nil="true" />
          </DiscountCurrencyList>
          <DiscountPercentageForOneItem>int</DiscountPercentageForOneItem>
          <DiscountPercentageForTwoItem>int</DiscountPercentageForTwoItem>
          <DiscountPercentageForThreeItem>int</DiscountPercentageForThreeItem>
          <DiscountPercentageForFourItem>int</DiscountPercentageForFourItem>
          <DiscountPercentageForMoreThenFourItem>int</DiscountPercentageForMoreThenFourItem>
          <DiscountFirstPriceSubscription>int</DiscountFirstPriceSubscription>
          <DiscountEachPriceSubscription>int</DiscountEachPriceSubscription>
          <AddFuturePublishedPrograms>boolean</AddFuturePublishedPrograms>
          <AddFuturePublishedCourses>boolean</AddFuturePublishedCourses>
          <AddFuturePublishedMaterials>boolean</AddFuturePublishedMaterials>
        </Coupon>
      </coupons>
    </AddCoupons>
  </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>
    <AddCouponsResponse xmlns="http://tempuri.org/">
      <AddCouponsResult>
        <string>string</string>
        <string>string</string>
      </AddCouponsResult>
    </AddCouponsResponse>
  </soap12:Body>
</soap12:Envelope>