API Web Service

API

Click here for a complete list of operations.

GetTimeShiftedTvPartnerSettings

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <GetTimeShiftedTvPartnerSettings xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
    </GetTimeShiftedTvPartnerSettings>
  </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>
    <GetTimeShiftedTvPartnerSettingsResponse xmlns="http://api.tvinci.com/">
      <GetTimeShiftedTvPartnerSettingsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Settings>
          <IsCatchUpEnabled>boolean</IsCatchUpEnabled>
          <IsCdvrEnabled>boolean</IsCdvrEnabled>
          <IsStartOverEnabled>boolean</IsStartOverEnabled>
          <IsTrickPlayEnabled>boolean</IsTrickPlayEnabled>
          <IsRecordingScheduleWindowEnabled>boolean</IsRecordingScheduleWindowEnabled>
          <IsProtectionEnabled>boolean</IsProtectionEnabled>
          <CatchUpBufferLength>long</CatchUpBufferLength>
          <TrickPlayBufferLength>long</TrickPlayBufferLength>
          <RecordingScheduleWindow>long</RecordingScheduleWindow>
          <PaddingAfterProgramEnds>long</PaddingAfterProgramEnds>
          <PaddingBeforeProgramStarts>long</PaddingBeforeProgramStarts>
          <ProtectionPeriod>int</ProtectionPeriod>
          <ProtectionQuotaPercentage>int</ProtectionQuotaPercentage>
          <RecordingLifetimePeriod>int</RecordingLifetimePeriod>
          <CleanupNoticePeriod>int</CleanupNoticePeriod>
          <IsSeriesRecordingEnabled>boolean</IsSeriesRecordingEnabled>
          <IsRecordingPlaybackNonEntitledChannelEnabled>boolean</IsRecordingPlaybackNonEntitledChannelEnabled>
          <IsRecordingPlaybackNonExistingChannelEnabled>boolean</IsRecordingPlaybackNonExistingChannelEnabled>
          <QuotaOveragePolicy>StopAtQuota or FIFOAutoDelete</QuotaOveragePolicy>
          <ProtectionPolicy>ExtendingRecordingLifetime or LimitedByRecordingLifetime</ProtectionPolicy>
          <RecoveryGracePeriod>int</RecoveryGracePeriod>
          <IsPrivateCopyEnabled>boolean</IsPrivateCopyEnabled>
          <DefaultQuota>int</DefaultQuota>
          <PersonalizedRecordingEnable>boolean</PersonalizedRecordingEnable>
          <MaxRecordingConcurrency>int</MaxRecordingConcurrency>
          <MaxConcurrencyMargin>int</MaxConcurrencyMargin>
          <AdapterId>int</AdapterId>
          <IsDefault>boolean</IsDefault>
        </Settings>
      </GetTimeShiftedTvPartnerSettingsResult>
    </GetTimeShiftedTvPartnerSettingsResponse>
  </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 /api.asmx HTTP/1.1
Host: extws.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>
    <GetTimeShiftedTvPartnerSettings xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
    </GetTimeShiftedTvPartnerSettings>
  </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>
    <GetTimeShiftedTvPartnerSettingsResponse xmlns="http://api.tvinci.com/">
      <GetTimeShiftedTvPartnerSettingsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Settings>
          <IsCatchUpEnabled>boolean</IsCatchUpEnabled>
          <IsCdvrEnabled>boolean</IsCdvrEnabled>
          <IsStartOverEnabled>boolean</IsStartOverEnabled>
          <IsTrickPlayEnabled>boolean</IsTrickPlayEnabled>
          <IsRecordingScheduleWindowEnabled>boolean</IsRecordingScheduleWindowEnabled>
          <IsProtectionEnabled>boolean</IsProtectionEnabled>
          <CatchUpBufferLength>long</CatchUpBufferLength>
          <TrickPlayBufferLength>long</TrickPlayBufferLength>
          <RecordingScheduleWindow>long</RecordingScheduleWindow>
          <PaddingAfterProgramEnds>long</PaddingAfterProgramEnds>
          <PaddingBeforeProgramStarts>long</PaddingBeforeProgramStarts>
          <ProtectionPeriod>int</ProtectionPeriod>
          <ProtectionQuotaPercentage>int</ProtectionQuotaPercentage>
          <RecordingLifetimePeriod>int</RecordingLifetimePeriod>
          <CleanupNoticePeriod>int</CleanupNoticePeriod>
          <IsSeriesRecordingEnabled>boolean</IsSeriesRecordingEnabled>
          <IsRecordingPlaybackNonEntitledChannelEnabled>boolean</IsRecordingPlaybackNonEntitledChannelEnabled>
          <IsRecordingPlaybackNonExistingChannelEnabled>boolean</IsRecordingPlaybackNonExistingChannelEnabled>
          <QuotaOveragePolicy>StopAtQuota or FIFOAutoDelete</QuotaOveragePolicy>
          <ProtectionPolicy>ExtendingRecordingLifetime or LimitedByRecordingLifetime</ProtectionPolicy>
          <RecoveryGracePeriod>int</RecoveryGracePeriod>
          <IsPrivateCopyEnabled>boolean</IsPrivateCopyEnabled>
          <DefaultQuota>int</DefaultQuota>
          <PersonalizedRecordingEnable>boolean</PersonalizedRecordingEnable>
          <MaxRecordingConcurrency>int</MaxRecordingConcurrency>
          <MaxConcurrencyMargin>int</MaxConcurrencyMargin>
          <AdapterId>int</AdapterId>
          <IsDefault>boolean</IsDefault>
        </Settings>
      </GetTimeShiftedTvPartnerSettingsResult>
    </GetTimeShiftedTvPartnerSettingsResponse>
  </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 /api.asmx/GetTimeShiftedTvPartnerSettings HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sWSUserName=string&sWSPassword=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<TimeShiftedTvPartnerSettingsResponse xmlns="http://api.tvinci.com/">
  <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>
  <Settings>
    <IsCatchUpEnabled>boolean</IsCatchUpEnabled>
    <IsCdvrEnabled>boolean</IsCdvrEnabled>
    <IsStartOverEnabled>boolean</IsStartOverEnabled>
    <IsTrickPlayEnabled>boolean</IsTrickPlayEnabled>
    <IsRecordingScheduleWindowEnabled>boolean</IsRecordingScheduleWindowEnabled>
    <IsProtectionEnabled>boolean</IsProtectionEnabled>
    <CatchUpBufferLength>long</CatchUpBufferLength>
    <TrickPlayBufferLength>long</TrickPlayBufferLength>
    <RecordingScheduleWindow>long</RecordingScheduleWindow>
    <PaddingAfterProgramEnds>long</PaddingAfterProgramEnds>
    <PaddingBeforeProgramStarts>long</PaddingBeforeProgramStarts>
    <ProtectionPeriod>int</ProtectionPeriod>
    <ProtectionQuotaPercentage>int</ProtectionQuotaPercentage>
    <RecordingLifetimePeriod>int</RecordingLifetimePeriod>
    <CleanupNoticePeriod>int</CleanupNoticePeriod>
    <IsSeriesRecordingEnabled>boolean</IsSeriesRecordingEnabled>
    <IsRecordingPlaybackNonEntitledChannelEnabled>boolean</IsRecordingPlaybackNonEntitledChannelEnabled>
    <IsRecordingPlaybackNonExistingChannelEnabled>boolean</IsRecordingPlaybackNonExistingChannelEnabled>
    <QuotaOveragePolicy>StopAtQuota or FIFOAutoDelete</QuotaOveragePolicy>
    <ProtectionPolicy>ExtendingRecordingLifetime or LimitedByRecordingLifetime</ProtectionPolicy>
    <RecoveryGracePeriod>int</RecoveryGracePeriod>
    <IsPrivateCopyEnabled>boolean</IsPrivateCopyEnabled>
    <DefaultQuota>int</DefaultQuota>
    <PersonalizedRecordingEnable>boolean</PersonalizedRecordingEnable>
    <MaxRecordingConcurrency>int</MaxRecordingConcurrency>
    <MaxConcurrencyMargin>int</MaxConcurrencyMargin>
    <AdapterId>int</AdapterId>
    <IsDefault>boolean</IsDefault>
  </Settings>
</TimeShiftedTvPartnerSettingsResponse>

Parameter	Value
sWSUserName:
sWSPassword: