module Web Service

module

Click here for a complete list of operations.

SearchDomainRecordings

Test

The test form is only available for requests from the local machine.

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

<?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>
    <SearchDomainRecordings xmlns="http://ca.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <userID>string</userID>
      <domainID>long</domainID>
      <recordingStatuses>
        <TstvRecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</TstvRecordingStatus>
        <TstvRecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</TstvRecordingStatus>
      </recordingStatuses>
      <filter>string</filter>
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <orderBy>
        <m_eOrderBy>ID or VIEWS or RATING or VOTES_COUNT or LIKE_COUNTER or START_DATE or NAME or CREATE_DATE or META or RANDOM or RELATED or NONE or RECOMMENDATION or UPDATE_DATE or MEDIA_ID or EPG_ID</m_eOrderBy>
        <m_eOrderDir>ASC or DESC or NONE</m_eOrderDir>
        <lu_min_period_id>int</lu_min_period_id>
        <m_sOrderValue>string</m_sOrderValue>
        <m_bIsSlidingWindowField>boolean</m_bIsSlidingWindowField>
        <isSlidingWindowFromRestApi>boolean</isSlidingWindowFromRestApi>
        <shouldPadString>boolean</shouldPadString>
        <trendingAssetWindow>dateTime</trendingAssetWindow>
      </orderBy>
      <shouldIgnorePaging>boolean</shouldIgnorePaging>
    </SearchDomainRecordings>
  </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>
    <SearchDomainRecordingsResponse xmlns="http://ca.tvinci.com/">
      <SearchDomainRecordingsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Recordings>
          <Recording>
            <Status xsi:nil="true" />
            <Id>long</Id>
            <EpgId>long</EpgId>
            <ChannelId>long</ChannelId>
            <RecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</RecordingStatus>
            <ExternalRecordingId>string</ExternalRecordingId>
            <EpgStartDate>dateTime</EpgStartDate>
            <EpgEndDate>dateTime</EpgEndDate>
            <Type>Single or Season or Series or OriginalBroadcast</Type>
            <GetStatusRetries>int</GetStatusRetries>
            <ProtectedUntilDate>long</ProtectedUntilDate>
            <ViewableUntilDate>long</ViewableUntilDate>
            <CreateDate>dateTime</CreateDate>
            <UpdateDate>dateTime</UpdateDate>
            <Crid>string</Crid>
            <isExternalRecording>boolean</isExternalRecording>
            <IsProtected>boolean</IsProtected>
            <UserId>string</UserId>
            <IsStartPaddingDefault>boolean</IsStartPaddingDefault>
            <IsEndPaddingDefault>boolean</IsEndPaddingDefault>
            <EndPadding>int</EndPadding>
            <StartPadding>int</StartPadding>
            <RecordedProgramId>long</RecordedProgramId>
            <AbsoluteStartTime>dateTime</AbsoluteStartTime>
            <AbsoluteEndTime>dateTime</AbsoluteEndTime>
            <Duration>long</Duration>
          </Recording>
          <Recording>
            <Status xsi:nil="true" />
            <Id>long</Id>
            <EpgId>long</EpgId>
            <ChannelId>long</ChannelId>
            <RecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</RecordingStatus>
            <ExternalRecordingId>string</ExternalRecordingId>
            <EpgStartDate>dateTime</EpgStartDate>
            <EpgEndDate>dateTime</EpgEndDate>
            <Type>Single or Season or Series or OriginalBroadcast</Type>
            <GetStatusRetries>int</GetStatusRetries>
            <ProtectedUntilDate>long</ProtectedUntilDate>
            <ViewableUntilDate>long</ViewableUntilDate>
            <CreateDate>dateTime</CreateDate>
            <UpdateDate>dateTime</UpdateDate>
            <Crid>string</Crid>
            <isExternalRecording>boolean</isExternalRecording>
            <IsProtected>boolean</IsProtected>
            <UserId>string</UserId>
            <IsStartPaddingDefault>boolean</IsStartPaddingDefault>
            <IsEndPaddingDefault>boolean</IsEndPaddingDefault>
            <EndPadding>int</EndPadding>
            <StartPadding>int</StartPadding>
            <RecordedProgramId>long</RecordedProgramId>
            <AbsoluteStartTime>dateTime</AbsoluteStartTime>
            <AbsoluteEndTime>dateTime</AbsoluteEndTime>
            <Duration>long</Duration>
          </Recording>
        </Recordings>
        <TotalItems>int</TotalItems>
      </SearchDomainRecordingsResult>
    </SearchDomainRecordingsResponse>
  </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 /ws_cas_module.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>
    <SearchDomainRecordings xmlns="http://ca.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <userID>string</userID>
      <domainID>long</domainID>
      <recordingStatuses>
        <TstvRecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</TstvRecordingStatus>
        <TstvRecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</TstvRecordingStatus>
      </recordingStatuses>
      <filter>string</filter>
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <orderBy>
        <m_eOrderBy>ID or VIEWS or RATING or VOTES_COUNT or LIKE_COUNTER or START_DATE or NAME or CREATE_DATE or META or RANDOM or RELATED or NONE or RECOMMENDATION or UPDATE_DATE or MEDIA_ID or EPG_ID</m_eOrderBy>
        <m_eOrderDir>ASC or DESC or NONE</m_eOrderDir>
        <lu_min_period_id>int</lu_min_period_id>
        <m_sOrderValue>string</m_sOrderValue>
        <m_bIsSlidingWindowField>boolean</m_bIsSlidingWindowField>
        <isSlidingWindowFromRestApi>boolean</isSlidingWindowFromRestApi>
        <shouldPadString>boolean</shouldPadString>
        <trendingAssetWindow>dateTime</trendingAssetWindow>
      </orderBy>
      <shouldIgnorePaging>boolean</shouldIgnorePaging>
    </SearchDomainRecordings>
  </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>
    <SearchDomainRecordingsResponse xmlns="http://ca.tvinci.com/">
      <SearchDomainRecordingsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Recordings>
          <Recording>
            <Status xsi:nil="true" />
            <Id>long</Id>
            <EpgId>long</EpgId>
            <ChannelId>long</ChannelId>
            <RecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</RecordingStatus>
            <ExternalRecordingId>string</ExternalRecordingId>
            <EpgStartDate>dateTime</EpgStartDate>
            <EpgEndDate>dateTime</EpgEndDate>
            <Type>Single or Season or Series or OriginalBroadcast</Type>
            <GetStatusRetries>int</GetStatusRetries>
            <ProtectedUntilDate>long</ProtectedUntilDate>
            <ViewableUntilDate>long</ViewableUntilDate>
            <CreateDate>dateTime</CreateDate>
            <UpdateDate>dateTime</UpdateDate>
            <Crid>string</Crid>
            <isExternalRecording>boolean</isExternalRecording>
            <IsProtected>boolean</IsProtected>
            <UserId>string</UserId>
            <IsStartPaddingDefault>boolean</IsStartPaddingDefault>
            <IsEndPaddingDefault>boolean</IsEndPaddingDefault>
            <EndPadding>int</EndPadding>
            <StartPadding>int</StartPadding>
            <RecordedProgramId>long</RecordedProgramId>
            <AbsoluteStartTime>dateTime</AbsoluteStartTime>
            <AbsoluteEndTime>dateTime</AbsoluteEndTime>
            <Duration>long</Duration>
          </Recording>
          <Recording>
            <Status xsi:nil="true" />
            <Id>long</Id>
            <EpgId>long</EpgId>
            <ChannelId>long</ChannelId>
            <RecordingStatus>OK or Failed or Scheduled or Recording or Recorded or Canceled or Deleted or LifeTimePeriodExpired or SeriesCancel or SeriesDelete or DeletePending</RecordingStatus>
            <ExternalRecordingId>string</ExternalRecordingId>
            <EpgStartDate>dateTime</EpgStartDate>
            <EpgEndDate>dateTime</EpgEndDate>
            <Type>Single or Season or Series or OriginalBroadcast</Type>
            <GetStatusRetries>int</GetStatusRetries>
            <ProtectedUntilDate>long</ProtectedUntilDate>
            <ViewableUntilDate>long</ViewableUntilDate>
            <CreateDate>dateTime</CreateDate>
            <UpdateDate>dateTime</UpdateDate>
            <Crid>string</Crid>
            <isExternalRecording>boolean</isExternalRecording>
            <IsProtected>boolean</IsProtected>
            <UserId>string</UserId>
            <IsStartPaddingDefault>boolean</IsStartPaddingDefault>
            <IsEndPaddingDefault>boolean</IsEndPaddingDefault>
            <EndPadding>int</EndPadding>
            <StartPadding>int</StartPadding>
            <RecordedProgramId>long</RecordedProgramId>
            <AbsoluteStartTime>dateTime</AbsoluteStartTime>
            <AbsoluteEndTime>dateTime</AbsoluteEndTime>
            <Duration>long</Duration>
          </Recording>
        </Recordings>
        <TotalItems>int</TotalItems>
      </SearchDomainRecordingsResult>
    </SearchDomainRecordingsResponse>
  </soap12:Body>
</soap12:Envelope>