module


Click here for a complete list of operations.

GetCouponStatus

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sWSUserName:
sWSPassword:
sCouponCode:

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 /restful_v5_2_4/ws_pricing_module.asmx HTTP/1.1
Host: rest-sgs1.ott.kaltura.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://pricing.tvinci.com/GetCouponStatus"

<?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>
    <GetCouponStatus xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sCouponCode>string</sCouponCode>
    </GetCouponStatus>
  </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>
    <GetCouponStatusResponse xmlns="http://pricing.tvinci.com/">
      <GetCouponStatusResult>
        <Coupon>
          <m_oCouponGroup>
            <m_sDescription xsi:nil="true" />
            <m_dEndDate>dateTime</m_dEndDate>
            <m_sGroupCode>string</m_sGroupCode>
            <m_sGroupName>string</m_sGroupName>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_nMaxUseCountForCoupon>int</m_nMaxUseCountForCoupon>
            <m_nMaxRecurringUsesCountForCoupon>int</m_nMaxRecurringUsesCountForCoupon>
            <maxDomainUses>int</maxDomainUses>
            <m_sDiscountCode>string</m_sDiscountCode>
            <m_oDiscountCode xsi:nil="true" />
            <m_nFinancialEntityID>int</m_nFinancialEntityID>
            <alias>string</alias>
            <couponGroupType>Coupon or GiftCard</couponGroupType>
          </m_oCouponGroup>
          <leftUses>int</leftUses>
          <totalUses>int</totalUses>
          <m_CouponStatus>Valid or NotExists or AllreadyUsed or IrrelevantCode or Expired or NotActive</m_CouponStatus>
          <m_CouponType>Unknown or Coupon or Voucher</m_CouponType>
          <m_campID>long</m_campID>
          <m_ownerGUID>long</m_ownerGUID>
          <m_ownerMedia>long</m_ownerMedia>
          <id>string</id>
        </Coupon>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetCouponStatusResult>
    </GetCouponStatusResponse>
  </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 /restful_v5_2_4/ws_pricing_module.asmx HTTP/1.1
Host: rest-sgs1.ott.kaltura.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>
    <GetCouponStatus xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sCouponCode>string</sCouponCode>
    </GetCouponStatus>
  </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>
    <GetCouponStatusResponse xmlns="http://pricing.tvinci.com/">
      <GetCouponStatusResult>
        <Coupon>
          <m_oCouponGroup>
            <m_sDescription xsi:nil="true" />
            <m_dEndDate>dateTime</m_dEndDate>
            <m_sGroupCode>string</m_sGroupCode>
            <m_sGroupName>string</m_sGroupName>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_nMaxUseCountForCoupon>int</m_nMaxUseCountForCoupon>
            <m_nMaxRecurringUsesCountForCoupon>int</m_nMaxRecurringUsesCountForCoupon>
            <maxDomainUses>int</maxDomainUses>
            <m_sDiscountCode>string</m_sDiscountCode>
            <m_oDiscountCode xsi:nil="true" />
            <m_nFinancialEntityID>int</m_nFinancialEntityID>
            <alias>string</alias>
            <couponGroupType>Coupon or GiftCard</couponGroupType>
          </m_oCouponGroup>
          <leftUses>int</leftUses>
          <totalUses>int</totalUses>
          <m_CouponStatus>Valid or NotExists or AllreadyUsed or IrrelevantCode or Expired or NotActive</m_CouponStatus>
          <m_CouponType>Unknown or Coupon or Voucher</m_CouponType>
          <m_campID>long</m_campID>
          <m_ownerGUID>long</m_ownerGUID>
          <m_ownerMedia>long</m_ownerMedia>
          <id>string</id>
        </Coupon>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetCouponStatusResult>
    </GetCouponStatusResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /restful_v5_2_4/ws_pricing_module.asmx/GetCouponStatus HTTP/1.1
Host: rest-sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sWSUserName=string&sWSPassword=string&sCouponCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CouponDataResponse xmlns="http://pricing.tvinci.com/">
  <Coupon>
    <m_oCouponGroup>
      <m_sDescription>
        <LanguageContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LanguageContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_sDescription>
      <m_dEndDate>dateTime</m_dEndDate>
      <m_sGroupCode>string</m_sGroupCode>
      <m_sGroupName>string</m_sGroupName>
      <m_dStartDate>dateTime</m_dStartDate>
      <m_nMaxUseCountForCoupon>int</m_nMaxUseCountForCoupon>
      <m_nMaxRecurringUsesCountForCoupon>int</m_nMaxRecurringUsesCountForCoupon>
      <maxDomainUses>int</maxDomainUses>
      <m_sDiscountCode>string</m_sDiscountCode>
      <m_oDiscountCode>
        <m_dEndDate>dateTime</m_dEndDate>
        <m_dPercent>double</m_dPercent>
        <m_dStartDate>dateTime</m_dStartDate>
        <m_eTheRelationType>And or Or</m_eTheRelationType>
        <m_oWhenAlgo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <alias>string</alias>
      </m_oDiscountCode>
      <m_nFinancialEntityID>int</m_nFinancialEntityID>
      <alias>string</alias>
      <couponGroupType>Coupon or GiftCard</couponGroupType>
    </m_oCouponGroup>
    <leftUses>int</leftUses>
    <totalUses>int</totalUses>
    <m_CouponStatus>Valid or NotExists or AllreadyUsed or IrrelevantCode or Expired or NotActive</m_CouponStatus>
    <m_CouponType>Unknown or Coupon or Voucher</m_CouponType>
    <m_campID>long</m_campID>
    <m_ownerGUID>long</m_ownerGUID>
    <m_ownerMedia>long</m_ownerMedia>
    <id>string</id>
  </Coupon>
  <Status>
    <Code>int</Code>
    <Message>string</Message>
    <Args>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
    </Args>
  </Status>
</CouponDataResponse>