module


Click here for a complete list of operations.

GetSubscriptions

Test

The test form is only available for methods with primitive types as parameters.

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

<?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>
    <GetSubscriptions xmlns="http://pricing.tvinci.com/">
      <sWSUsername>string</sWSUsername>
      <sWSPassword>string</sWSPassword>
      <oSubCodes>
        <string>string</string>
        <string>string</string>
      </oSubCodes>
      <sCountryCd2>string</sCountryCd2>
      <sLanguageCode3>string</sLanguageCode3>
      <sDeviceName>string</sDeviceName>
      <orderBy>StartDateAsc or StartDateDesc</orderBy>
    </GetSubscriptions>
  </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>
    <GetSubscriptionsResponse xmlns="http://pricing.tvinci.com/">
      <GetSubscriptionsResult>
        <Subscriptions>
          <Subscription>
            <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
            <m_bIsRecurring>boolean</m_bIsRecurring>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_fictivicMediaID>int</m_fictivicMediaID>
            <m_MultiSubscriptionUsageModule xsi:nil="true" />
            <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
            <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
            <m_oPreviewModule xsi:nil="true" />
            <m_oSubscriptionPriceCode xsi:nil="true" />
            <m_oSubscriptionUsageModule xsi:nil="true" />
            <m_Priority>long</m_Priority>
            <m_ProductCode>string</m_ProductCode>
            <m_sCodes xsi:nil="true" />
            <m_sFileTypes xsi:nil="true" />
            <m_sName xsi:nil="true" />
            <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
            <m_SubscriptionCode>string</m_SubscriptionCode>
            <m_UserTypes xsi:nil="true" />
            <BlockCancellation>boolean</BlockCancellation>
            <PreSaleDate>dateTime</PreSaleDate>
            <m_oExtDisountModule xsi:nil="true" />
            <n_GeoCommerceID>int</n_GeoCommerceID>
            <m_lServices xsi:nil="true" />
            <SubscriptionSetIdsToPriority xsi:nil="true" />
            <CouponsGroups xsi:nil="true" />
            <ExternalProductCodes xsi:nil="true" />
            <Type>NotApplicable or Base or AddOn</Type>
          </Subscription>
          <Subscription>
            <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
            <m_bIsRecurring>boolean</m_bIsRecurring>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_fictivicMediaID>int</m_fictivicMediaID>
            <m_MultiSubscriptionUsageModule xsi:nil="true" />
            <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
            <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
            <m_oPreviewModule xsi:nil="true" />
            <m_oSubscriptionPriceCode xsi:nil="true" />
            <m_oSubscriptionUsageModule xsi:nil="true" />
            <m_Priority>long</m_Priority>
            <m_ProductCode>string</m_ProductCode>
            <m_sCodes xsi:nil="true" />
            <m_sFileTypes xsi:nil="true" />
            <m_sName xsi:nil="true" />
            <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
            <m_SubscriptionCode>string</m_SubscriptionCode>
            <m_UserTypes xsi:nil="true" />
            <BlockCancellation>boolean</BlockCancellation>
            <PreSaleDate>dateTime</PreSaleDate>
            <m_oExtDisountModule xsi:nil="true" />
            <n_GeoCommerceID>int</n_GeoCommerceID>
            <m_lServices xsi:nil="true" />
            <SubscriptionSetIdsToPriority xsi:nil="true" />
            <CouponsGroups xsi:nil="true" />
            <ExternalProductCodes xsi:nil="true" />
            <Type>NotApplicable or Base or AddOn</Type>
          </Subscription>
        </Subscriptions>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetSubscriptionsResult>
    </GetSubscriptionsResponse>
  </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>
    <GetSubscriptions xmlns="http://pricing.tvinci.com/">
      <sWSUsername>string</sWSUsername>
      <sWSPassword>string</sWSPassword>
      <oSubCodes>
        <string>string</string>
        <string>string</string>
      </oSubCodes>
      <sCountryCd2>string</sCountryCd2>
      <sLanguageCode3>string</sLanguageCode3>
      <sDeviceName>string</sDeviceName>
      <orderBy>StartDateAsc or StartDateDesc</orderBy>
    </GetSubscriptions>
  </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>
    <GetSubscriptionsResponse xmlns="http://pricing.tvinci.com/">
      <GetSubscriptionsResult>
        <Subscriptions>
          <Subscription>
            <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
            <m_bIsRecurring>boolean</m_bIsRecurring>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_fictivicMediaID>int</m_fictivicMediaID>
            <m_MultiSubscriptionUsageModule xsi:nil="true" />
            <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
            <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
            <m_oPreviewModule xsi:nil="true" />
            <m_oSubscriptionPriceCode xsi:nil="true" />
            <m_oSubscriptionUsageModule xsi:nil="true" />
            <m_Priority>long</m_Priority>
            <m_ProductCode>string</m_ProductCode>
            <m_sCodes xsi:nil="true" />
            <m_sFileTypes xsi:nil="true" />
            <m_sName xsi:nil="true" />
            <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
            <m_SubscriptionCode>string</m_SubscriptionCode>
            <m_UserTypes xsi:nil="true" />
            <BlockCancellation>boolean</BlockCancellation>
            <PreSaleDate>dateTime</PreSaleDate>
            <m_oExtDisountModule xsi:nil="true" />
            <n_GeoCommerceID>int</n_GeoCommerceID>
            <m_lServices xsi:nil="true" />
            <SubscriptionSetIdsToPriority xsi:nil="true" />
            <CouponsGroups xsi:nil="true" />
            <ExternalProductCodes xsi:nil="true" />
            <Type>NotApplicable or Base or AddOn</Type>
          </Subscription>
          <Subscription>
            <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
            <m_bIsRecurring>boolean</m_bIsRecurring>
            <m_dStartDate>dateTime</m_dStartDate>
            <m_dEndDate>dateTime</m_dEndDate>
            <m_fictivicMediaID>int</m_fictivicMediaID>
            <m_MultiSubscriptionUsageModule xsi:nil="true" />
            <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
            <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
            <m_oPreviewModule xsi:nil="true" />
            <m_oSubscriptionPriceCode xsi:nil="true" />
            <m_oSubscriptionUsageModule xsi:nil="true" />
            <m_Priority>long</m_Priority>
            <m_ProductCode>string</m_ProductCode>
            <m_sCodes xsi:nil="true" />
            <m_sFileTypes xsi:nil="true" />
            <m_sName xsi:nil="true" />
            <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
            <m_SubscriptionCode>string</m_SubscriptionCode>
            <m_UserTypes xsi:nil="true" />
            <BlockCancellation>boolean</BlockCancellation>
            <PreSaleDate>dateTime</PreSaleDate>
            <m_oExtDisountModule xsi:nil="true" />
            <n_GeoCommerceID>int</n_GeoCommerceID>
            <m_lServices xsi:nil="true" />
            <SubscriptionSetIdsToPriority xsi:nil="true" />
            <CouponsGroups xsi:nil="true" />
            <ExternalProductCodes xsi:nil="true" />
            <Type>NotApplicable or Base or AddOn</Type>
          </Subscription>
        </Subscriptions>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
      </GetSubscriptionsResult>
    </GetSubscriptionsResponse>
  </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/GetSubscriptions HTTP/1.1
Host: rest-sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<SubscriptionsResponse xmlns="http://pricing.tvinci.com/">
  <Subscriptions>
    <Subscription>
      <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
      <m_bIsRecurring>boolean</m_bIsRecurring>
      <m_dStartDate>dateTime</m_dStartDate>
      <m_dEndDate>dateTime</m_dEndDate>
      <m_fictivicMediaID>int</m_fictivicMediaID>
      <m_MultiSubscriptionUsageModule>
        <UsageModule d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <UsageModule d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_MultiSubscriptionUsageModule>
      <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
      <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
      <m_oPreviewModule>
        <m_nID>long</m_nID>
        <m_tsFullLifeCycle>int</m_tsFullLifeCycle>
        <m_sName>string</m_sName>
        <m_tsNonRenewPeriod>int</m_tsNonRenewPeriod>
        <alias>string</alias>
      </m_oPreviewModule>
      <m_oSubscriptionPriceCode>
        <m_sDescription d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_nObjectID>int</m_nObjectID>
        <m_sCode>string</m_sCode>
        <m_oPrise d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_oSubscriptionPriceCode>
      <m_oSubscriptionUsageModule>
        <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_oSubscriptionUsageModule>
      <m_Priority>long</m_Priority>
      <m_ProductCode>string</m_ProductCode>
      <m_sCodes>
        <BundleCodeContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BundleCodeContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_sCodes>
      <m_sFileTypes>
        <int>int</int>
        <int>int</int>
      </m_sFileTypes>
      <m_sName>
        <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_sName>
      <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
      <m_SubscriptionCode>string</m_SubscriptionCode>
      <m_UserTypes>
        <UserType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <UserType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_UserTypes>
      <BlockCancellation>boolean</BlockCancellation>
      <PreSaleDate>dateTime</PreSaleDate>
      <m_oExtDisountModule>
        <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_oExtDisountModule>
      <n_GeoCommerceID>int</n_GeoCommerceID>
      <m_lServices>
        <ServiceObject d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ServiceObject d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_lServices>
      <SubscriptionSetIdsToPriority>
        <KeyValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <KeyValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SubscriptionSetIdsToPriority>
      <CouponsGroups>
        <SubscriptionCouponGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SubscriptionCouponGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CouponsGroups>
      <ExternalProductCodes>
        <KeyValuePairOfVerificationPaymentGatewayString d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <KeyValuePairOfVerificationPaymentGatewayString d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ExternalProductCodes>
      <Type>NotApplicable or Base or AddOn</Type>
    </Subscription>
    <Subscription>
      <m_bIsInfiniteRecurring>boolean</m_bIsInfiniteRecurring>
      <m_bIsRecurring>boolean</m_bIsRecurring>
      <m_dStartDate>dateTime</m_dStartDate>
      <m_dEndDate>dateTime</m_dEndDate>
      <m_fictivicMediaID>int</m_fictivicMediaID>
      <m_MultiSubscriptionUsageModule>
        <UsageModule d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <UsageModule d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_MultiSubscriptionUsageModule>
      <m_nDomainLimitationModule>int</m_nDomainLimitationModule>
      <m_nNumberOfRecPeriods>int</m_nNumberOfRecPeriods>
      <m_oPreviewModule>
        <m_nID>long</m_nID>
        <m_tsFullLifeCycle>int</m_tsFullLifeCycle>
        <m_sName>string</m_sName>
        <m_tsNonRenewPeriod>int</m_tsNonRenewPeriod>
        <alias>string</alias>
      </m_oPreviewModule>
      <m_oSubscriptionPriceCode>
        <m_sDescription d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <m_nObjectID>int</m_nObjectID>
        <m_sCode>string</m_sCode>
        <m_oPrise d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_oSubscriptionPriceCode>
      <m_oSubscriptionUsageModule>
        <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_oSubscriptionUsageModule>
      <m_Priority>long</m_Priority>
      <m_ProductCode>string</m_ProductCode>
      <m_sCodes>
        <BundleCodeContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <BundleCodeContainer d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_sCodes>
      <m_sFileTypes>
        <int>int</int>
        <int>int</int>
      </m_sFileTypes>
      <m_sName>
        <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_sName>
      <m_GracePeriodMinutes>int</m_GracePeriodMinutes>
      <m_SubscriptionCode>string</m_SubscriptionCode>
      <m_UserTypes>
        <UserType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <UserType d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_UserTypes>
      <BlockCancellation>boolean</BlockCancellation>
      <PreSaleDate>dateTime</PreSaleDate>
      <m_oExtDisountModule>
        <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_oExtDisountModule>
      <n_GeoCommerceID>int</n_GeoCommerceID>
      <m_lServices>
        <ServiceObject d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <ServiceObject d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </m_lServices>
      <SubscriptionSetIdsToPriority>
        <KeyValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <KeyValuePair d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </SubscriptionSetIdsToPriority>
      <CouponsGroups>
        <SubscriptionCouponGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SubscriptionCouponGroup d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CouponsGroups>
      <ExternalProductCodes>
        <KeyValuePairOfVerificationPaymentGatewayString d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <KeyValuePairOfVerificationPaymentGatewayString d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </ExternalProductCodes>
      <Type>NotApplicable or Base or AddOn</Type>
    </Subscription>
  </Subscriptions>
  <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>
</SubscriptionsResponse>