module


Click here for a complete list of operations.

GetCampaignsByHash

Test

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

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

<?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>
    <GetCampaignsByHash xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <hashCode>string</hashCode>
    </GetCampaignsByHash>
  </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>
    <GetCampaignsByHashResponse xmlns="http://pricing.tvinci.com/">
      <GetCampaignsByHashResult>
        <m_Name>string</m_Name>
        <m_ID>long</m_ID>
        <m_Description>string</m_Description>
        <m_usageModule>
          <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_usageModule>
        <m_startDate>dateTime</m_startDate>
        <m_endDate>dateTime</m_endDate>
        <m_oCouponsGroup>
          <m_sDescription>
            <LanguageContainer xsi:nil="true" />
            <LanguageContainer xsi:nil="true" />
          </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 xsi:nil="true" />
            <alias>string</alias>
          </m_oDiscountCode>
          <m_nFinancialEntityID>int</m_nFinancialEntityID>
          <alias>string</alias>
          <couponGroupType>Coupon or GiftCard</couponGroupType>
        </m_oCouponsGroup>
        <m_CampaignTrigger>Unknown or Purchase or SocialInvite</m_CampaignTrigger>
        <m_CampaignResult>Unknown or Voucher or ExtendSubscription</m_CampaignResult>
        <m_CampaignType>Unknown or Time or Event</m_CampaignType>
        <m_subscriptionCode>int</m_subscriptionCode>
        <m_IsActive>boolean</m_IsActive>
      </GetCampaignsByHashResult>
    </GetCampaignsByHashResponse>
  </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>
    <GetCampaignsByHash xmlns="http://pricing.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <hashCode>string</hashCode>
    </GetCampaignsByHash>
  </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>
    <GetCampaignsByHashResponse xmlns="http://pricing.tvinci.com/">
      <GetCampaignsByHashResult>
        <m_Name>string</m_Name>
        <m_ID>long</m_ID>
        <m_Description>string</m_Description>
        <m_usageModule>
          <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_usageModule>
        <m_startDate>dateTime</m_startDate>
        <m_endDate>dateTime</m_endDate>
        <m_oCouponsGroup>
          <m_sDescription>
            <LanguageContainer xsi:nil="true" />
            <LanguageContainer xsi:nil="true" />
          </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 xsi:nil="true" />
            <alias>string</alias>
          </m_oDiscountCode>
          <m_nFinancialEntityID>int</m_nFinancialEntityID>
          <alias>string</alias>
          <couponGroupType>Coupon or GiftCard</couponGroupType>
        </m_oCouponsGroup>
        <m_CampaignTrigger>Unknown or Purchase or SocialInvite</m_CampaignTrigger>
        <m_CampaignResult>Unknown or Voucher or ExtendSubscription</m_CampaignResult>
        <m_CampaignType>Unknown or Time or Event</m_CampaignType>
        <m_subscriptionCode>int</m_subscriptionCode>
        <m_IsActive>boolean</m_IsActive>
      </GetCampaignsByHashResult>
    </GetCampaignsByHashResponse>
  </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/GetCampaignsByHash HTTP/1.1
Host: rest-sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<Campaign xmlns="http://pricing.tvinci.com/">
  <m_Name>string</m_Name>
  <m_ID>long</m_ID>
  <m_Description>string</m_Description>
  <m_usageModule>
    <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_usageModule>
  <m_startDate>dateTime</m_startDate>
  <m_endDate>dateTime</m_endDate>
  <m_oCouponsGroup>
    <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_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>
        <m_eAlgoType>N_FIRST_TIMES or EVERY_N_TIMES</m_eAlgoType>
        <m_nNTimes>int</m_nNTimes>
      </m_oWhenAlgo>
      <alias>string</alias>
    </m_oDiscountCode>
    <m_nFinancialEntityID>int</m_nFinancialEntityID>
    <alias>string</alias>
    <couponGroupType>Coupon or GiftCard</couponGroupType>
  </m_oCouponsGroup>
  <m_CampaignTrigger>Unknown or Purchase or SocialInvite</m_CampaignTrigger>
  <m_CampaignResult>Unknown or Voucher or ExtendSubscription</m_CampaignResult>
  <m_CampaignType>Unknown or Time or Event</m_CampaignType>
  <m_subscriptionCode>int</m_subscriptionCode>
  <m_IsActive>boolean</m_IsActive>
</Campaign>