module


Click here for a complete list of operations.

GetPPVModuleResponse

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sWSUserName:
sWSPassword:
sPPVCode:
sCountryCd2:
sLanguageCode3:
sDeviceName:

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/GetPPVModuleResponse"

<?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>
    <GetPPVModuleResponse xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sPPVCode>string</sPPVCode>
      <sCountryCd2>string</sCountryCd2>
      <sLanguageCode3>string</sLanguageCode3>
      <sDeviceName>string</sDeviceName>
    </GetPPVModuleResponse>
  </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>
    <GetPPVModuleResponseResponse xmlns="http://pricing.tvinci.com/">
      <GetPPVModuleResponseResult>
        <PPVModule>
          <m_oCouponsGroup>
            <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_oCouponsGroup>
          <m_oDiscountModule>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_dPercent>double</m_dPercent>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_eTheRelationType>And or Or</m_eTheRelationType>
            <m_oWhenAlgo xsi:nil="true" />
            <alias>string</alias>
          </m_oDiscountModule>
          <m_sDescription>
            <LanguageContainer xsi:nil="true" />
            <LanguageContainer xsi:nil="true" />
          </m_sDescription>
          <m_sObjectCode>string</m_sObjectCode>
          <m_relatedFileTypes>
            <int>int</int>
            <int>int</int>
          </m_relatedFileTypes>
          <m_bSubscriptionOnly>boolean</m_bSubscriptionOnly>
          <m_sObjectVirtualName>string</m_sObjectVirtualName>
          <m_oPriceCode>
            <m_sDescription xsi:nil="true" />
            <m_nObjectID>int</m_nObjectID>
            <m_sCode>string</m_sCode>
            <m_oPrise xsi:nil="true" />
          </m_oPriceCode>
          <m_Product_Code>string</m_Product_Code>
          <m_oUsageModule>
            <m_coupon_id>int</m_coupon_id>
            <m_tsMaxUsageModuleLifeCycle>int</m_tsMaxUsageModuleLifeCycle>
            <m_nObjectID>int</m_nObjectID>
            <m_bIsOfflinePlayBack>boolean</m_bIsOfflinePlayBack>
            <m_bWaiver>boolean</m_bWaiver>
            <m_nMaxNumberOfViews>int</m_nMaxNumberOfViews>
            <m_sVirtualName>string</m_sVirtualName>
            <m_tsViewLifeCycle>int</m_tsViewLifeCycle>
            <m_nWaiverPeriod>int</m_nWaiverPeriod>
            <m_is_renew>int</m_is_renew>
            <m_pricing_id>int</m_pricing_id>
            <m_num_of_rec_periods>int</m_num_of_rec_periods>
            <m_ext_discount_id>int</m_ext_discount_id>
            <m_internal_discount_id>int</m_internal_discount_id>
            <m_type>int</m_type>
            <m_subscription_only>int</m_subscription_only>
            <m_device_limit_id>int</m_device_limit_id>
          </m_oUsageModule>
          <m_bFirstDeviceLimitation>boolean</m_bFirstDeviceLimitation>
          <alias>string</alias>
          <AdsPolicy>NoAds or KeepAds</AdsPolicy>
          <AdsParam>string</AdsParam>
        </PPVModule>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetPPVModuleResponseResult>
    </GetPPVModuleResponseResponse>
  </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>
    <GetPPVModuleResponse xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <sPPVCode>string</sPPVCode>
      <sCountryCd2>string</sCountryCd2>
      <sLanguageCode3>string</sLanguageCode3>
      <sDeviceName>string</sDeviceName>
    </GetPPVModuleResponse>
  </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>
    <GetPPVModuleResponseResponse xmlns="http://pricing.tvinci.com/">
      <GetPPVModuleResponseResult>
        <PPVModule>
          <m_oCouponsGroup>
            <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_oCouponsGroup>
          <m_oDiscountModule>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_dPercent>double</m_dPercent>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_eTheRelationType>And or Or</m_eTheRelationType>
            <m_oWhenAlgo xsi:nil="true" />
            <alias>string</alias>
          </m_oDiscountModule>
          <m_sDescription>
            <LanguageContainer xsi:nil="true" />
            <LanguageContainer xsi:nil="true" />
          </m_sDescription>
          <m_sObjectCode>string</m_sObjectCode>
          <m_relatedFileTypes>
            <int>int</int>
            <int>int</int>
          </m_relatedFileTypes>
          <m_bSubscriptionOnly>boolean</m_bSubscriptionOnly>
          <m_sObjectVirtualName>string</m_sObjectVirtualName>
          <m_oPriceCode>
            <m_sDescription xsi:nil="true" />
            <m_nObjectID>int</m_nObjectID>
            <m_sCode>string</m_sCode>
            <m_oPrise xsi:nil="true" />
          </m_oPriceCode>
          <m_Product_Code>string</m_Product_Code>
          <m_oUsageModule>
            <m_coupon_id>int</m_coupon_id>
            <m_tsMaxUsageModuleLifeCycle>int</m_tsMaxUsageModuleLifeCycle>
            <m_nObjectID>int</m_nObjectID>
            <m_bIsOfflinePlayBack>boolean</m_bIsOfflinePlayBack>
            <m_bWaiver>boolean</m_bWaiver>
            <m_nMaxNumberOfViews>int</m_nMaxNumberOfViews>
            <m_sVirtualName>string</m_sVirtualName>
            <m_tsViewLifeCycle>int</m_tsViewLifeCycle>
            <m_nWaiverPeriod>int</m_nWaiverPeriod>
            <m_is_renew>int</m_is_renew>
            <m_pricing_id>int</m_pricing_id>
            <m_num_of_rec_periods>int</m_num_of_rec_periods>
            <m_ext_discount_id>int</m_ext_discount_id>
            <m_internal_discount_id>int</m_internal_discount_id>
            <m_type>int</m_type>
            <m_subscription_only>int</m_subscription_only>
            <m_device_limit_id>int</m_device_limit_id>
          </m_oUsageModule>
          <m_bFirstDeviceLimitation>boolean</m_bFirstDeviceLimitation>
          <alias>string</alias>
          <AdsPolicy>NoAds or KeepAds</AdsPolicy>
          <AdsParam>string</AdsParam>
        </PPVModule>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetPPVModuleResponseResult>
    </GetPPVModuleResponseResponse>
  </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/GetPPVModuleResponse HTTP/1.1
Host: rest-sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<PPVModuleDataResponse xmlns="http://pricing.tvinci.com/">
  <PPVModule>
    <m_oCouponsGroup>
      <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_oCouponsGroup>
    <m_oDiscountModule>
      <m_dEndDate>dateTime</m_dEndDate>
      <m_dPercent>double</m_dPercent>
      <m_dStartDate>dateTime</m_dStartDate>
      <m_eTheRelationType>And or Or</m_eTheRelationType>
      <m_oWhenAlgo>
        <m_eAlgoType>N_FIRST_TIMES or EVERY_N_TIMES</m_eAlgoType>
        <m_nNTimes>int</m_nNTimes>
      </m_oWhenAlgo>
      <alias>string</alias>
    </m_oDiscountModule>
    <m_sDescription>
      <LanguageContainer>
        <m_sLanguageCode3>string</m_sLanguageCode3>
        <m_sValue>string</m_sValue>
        <IsDefault>boolean</IsDefault>
      </LanguageContainer>
      <LanguageContainer>
        <m_sLanguageCode3>string</m_sLanguageCode3>
        <m_sValue>string</m_sValue>
        <IsDefault>boolean</IsDefault>
      </LanguageContainer>
    </m_sDescription>
    <m_sObjectCode>string</m_sObjectCode>
    <m_relatedFileTypes>
      <int>int</int>
      <int>int</int>
    </m_relatedFileTypes>
    <m_bSubscriptionOnly>boolean</m_bSubscriptionOnly>
    <m_sObjectVirtualName>string</m_sObjectVirtualName>
    <m_oPriceCode>
      <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_nObjectID>int</m_nObjectID>
      <m_sCode>string</m_sCode>
      <m_oPrise>
        <m_dPrice>double</m_dPrice>
        <m_oCurrency d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <countryId>int</countryId>
      </m_oPrise>
    </m_oPriceCode>
    <m_Product_Code>string</m_Product_Code>
    <m_oUsageModule>
      <m_coupon_id>int</m_coupon_id>
      <m_tsMaxUsageModuleLifeCycle>int</m_tsMaxUsageModuleLifeCycle>
      <m_nObjectID>int</m_nObjectID>
      <m_bIsOfflinePlayBack>boolean</m_bIsOfflinePlayBack>
      <m_bWaiver>boolean</m_bWaiver>
      <m_nMaxNumberOfViews>int</m_nMaxNumberOfViews>
      <m_sVirtualName>string</m_sVirtualName>
      <m_tsViewLifeCycle>int</m_tsViewLifeCycle>
      <m_nWaiverPeriod>int</m_nWaiverPeriod>
      <m_is_renew>int</m_is_renew>
      <m_pricing_id>int</m_pricing_id>
      <m_num_of_rec_periods>int</m_num_of_rec_periods>
      <m_ext_discount_id>int</m_ext_discount_id>
      <m_internal_discount_id>int</m_internal_discount_id>
      <m_type>int</m_type>
      <m_subscription_only>int</m_subscription_only>
      <m_device_limit_id>int</m_device_limit_id>
    </m_oUsageModule>
    <m_bFirstDeviceLimitation>boolean</m_bFirstDeviceLimitation>
    <alias>string</alias>
    <AdsPolicy>NoAds or KeepAds</AdsPolicy>
    <AdsParam>string</AdsParam>
  </PPVModule>
  <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>
</PPVModuleDataResponse>