module Web Service

module

Click here for a complete list of operations.

GetPlaybackContext

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

<?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>
    <GetPlaybackContext xmlns="http://ca.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <userId>string</userId>
      <udid>string</udid>
      <ip>string</ip>
      <assetId>string</assetId>
      <assetType>UNKNOWN or EPG or NPVR or MEDIA</assetType>
      <fileIds>
        <long>long</long>
        <long>long</long>
      </fileIds>
      <streamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</streamerType>
      <mediaProtocol>string</mediaProtocol>
      <context>Trailer or CatchUp or StartOver or Playback or Download</context>
      <urlType>playmanifest or direct</urlType>
    </GetPlaybackContext>
  </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>
    <GetPlaybackContextResponse xmlns="http://ca.tvinci.com/">
      <GetPlaybackContextResult>
        <AssetId>int</AssetId>
        <Files>
          <MediaFile>
            <MediaId>long</MediaId>
            <Id>long</Id>
            <Type>string</Type>
            <TypeId>long</TypeId>
            <Url>string</Url>
            <AltUrl>string</AltUrl>
            <DirectUrl>string</DirectUrl>
            <AltDirectUrl>string</AltDirectUrl>
            <Duration>long</Duration>
            <ExternalId>string</ExternalId>
            <StreamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</StreamerType>
            <IsTrailer>boolean</IsTrailer>
            <CdnId>int</CdnId>
            <AltCdnId>int</AltCdnId>
            <DrmId>int</DrmId>
            <AdsPolicy>None or NoAds or KeepAds</AdsPolicy>
            <AdsParam>string</AdsParam>
            <Opl>string</Opl>
            <BusinessModuleDetails xsi:nil="true" />
            <GroupId>long</GroupId>
            <Labels>string</Labels>
          </MediaFile>
          <MediaFile>
            <MediaId>long</MediaId>
            <Id>long</Id>
            <Type>string</Type>
            <TypeId>long</TypeId>
            <Url>string</Url>
            <AltUrl>string</AltUrl>
            <DirectUrl>string</DirectUrl>
            <AltDirectUrl>string</AltDirectUrl>
            <Duration>long</Duration>
            <ExternalId>string</ExternalId>
            <StreamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</StreamerType>
            <IsTrailer>boolean</IsTrailer>
            <CdnId>int</CdnId>
            <AltCdnId>int</AltCdnId>
            <DrmId>int</DrmId>
            <AdsPolicy>None or NoAds or KeepAds</AdsPolicy>
            <AdsParam>string</AdsParam>
            <Opl>string</Opl>
            <BusinessModuleDetails xsi:nil="true" />
            <GroupId>long</GroupId>
            <Labels>string</Labels>
          </MediaFile>
        </Files>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <ConcurrencyData>
          <UDID>string</UDID>
          <AssetId>int</AssetId>
          <UserId>int</UserId>
          <playType>string</playType>
          <AssetAction>string</AssetAction>
          <TimeStamp>long</TimeStamp>
          <CreatedAt>long</CreatedAt>
          <MediaConcurrencyRuleIds>
            <int>int</int>
            <int>int</int>
          </MediaConcurrencyRuleIds>
          <AssetMediaConcurrencyRuleIds>
            <long>long</long>
            <long>long</long>
          </AssetMediaConcurrencyRuleIds>
          <AssetEpgConcurrencyRuleIds>
            <long>long</long>
            <long>long</long>
          </AssetEpgConcurrencyRuleIds>
          <DeviceFamilyId>int</DeviceFamilyId>
          <NpvrId>string</NpvrId>
          <ProgramId>long</ProgramId>
          <DomainId>int</DomainId>
          <PlayCycleKey>string</PlayCycleKey>
          <BookmarkEventThreshold>int</BookmarkEventThreshold>
          <ProductType>PPV or Subscription or Collection or ProgramAssetGroupOffer</ProductType>
          <ProductId>int</ProductId>
          <Revoke>boolean</Revoke>
          <LinearWatchHistoryThreshold>int</LinearWatchHistoryThreshold>
          <IsFree>boolean</IsFree>
        </ConcurrencyData>
      </GetPlaybackContextResult>
    </GetPlaybackContextResponse>
  </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>
    <GetPlaybackContext xmlns="http://ca.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <userId>string</userId>
      <udid>string</udid>
      <ip>string</ip>
      <assetId>string</assetId>
      <assetType>UNKNOWN or EPG or NPVR or MEDIA</assetType>
      <fileIds>
        <long>long</long>
        <long>long</long>
      </fileIds>
      <streamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</streamerType>
      <mediaProtocol>string</mediaProtocol>
      <context>Trailer or CatchUp or StartOver or Playback or Download</context>
      <urlType>playmanifest or direct</urlType>
    </GetPlaybackContext>
  </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>
    <GetPlaybackContextResponse xmlns="http://ca.tvinci.com/">
      <GetPlaybackContextResult>
        <AssetId>int</AssetId>
        <Files>
          <MediaFile>
            <MediaId>long</MediaId>
            <Id>long</Id>
            <Type>string</Type>
            <TypeId>long</TypeId>
            <Url>string</Url>
            <AltUrl>string</AltUrl>
            <DirectUrl>string</DirectUrl>
            <AltDirectUrl>string</AltDirectUrl>
            <Duration>long</Duration>
            <ExternalId>string</ExternalId>
            <StreamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</StreamerType>
            <IsTrailer>boolean</IsTrailer>
            <CdnId>int</CdnId>
            <AltCdnId>int</AltCdnId>
            <DrmId>int</DrmId>
            <AdsPolicy>None or NoAds or KeepAds</AdsPolicy>
            <AdsParam>string</AdsParam>
            <Opl>string</Opl>
            <BusinessModuleDetails xsi:nil="true" />
            <GroupId>long</GroupId>
            <Labels>string</Labels>
          </MediaFile>
          <MediaFile>
            <MediaId>long</MediaId>
            <Id>long</Id>
            <Type>string</Type>
            <TypeId>long</TypeId>
            <Url>string</Url>
            <AltUrl>string</AltUrl>
            <DirectUrl>string</DirectUrl>
            <AltDirectUrl>string</AltDirectUrl>
            <Duration>long</Duration>
            <ExternalId>string</ExternalId>
            <StreamerType>none or applehttp or mpegdash or url or smothstreaming or multicast</StreamerType>
            <IsTrailer>boolean</IsTrailer>
            <CdnId>int</CdnId>
            <AltCdnId>int</AltCdnId>
            <DrmId>int</DrmId>
            <AdsPolicy>None or NoAds or KeepAds</AdsPolicy>
            <AdsParam>string</AdsParam>
            <Opl>string</Opl>
            <BusinessModuleDetails xsi:nil="true" />
            <GroupId>long</GroupId>
            <Labels>string</Labels>
          </MediaFile>
        </Files>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <ConcurrencyData>
          <UDID>string</UDID>
          <AssetId>int</AssetId>
          <UserId>int</UserId>
          <playType>string</playType>
          <AssetAction>string</AssetAction>
          <TimeStamp>long</TimeStamp>
          <CreatedAt>long</CreatedAt>
          <MediaConcurrencyRuleIds>
            <int>int</int>
            <int>int</int>
          </MediaConcurrencyRuleIds>
          <AssetMediaConcurrencyRuleIds>
            <long>long</long>
            <long>long</long>
          </AssetMediaConcurrencyRuleIds>
          <AssetEpgConcurrencyRuleIds>
            <long>long</long>
            <long>long</long>
          </AssetEpgConcurrencyRuleIds>
          <DeviceFamilyId>int</DeviceFamilyId>
          <NpvrId>string</NpvrId>
          <ProgramId>long</ProgramId>
          <DomainId>int</DomainId>
          <PlayCycleKey>string</PlayCycleKey>
          <BookmarkEventThreshold>int</BookmarkEventThreshold>
          <ProductType>PPV or Subscription or Collection or ProgramAssetGroupOffer</ProductType>
          <ProductId>int</ProductId>
          <Revoke>boolean</Revoke>
          <LinearWatchHistoryThreshold>int</LinearWatchHistoryThreshold>
          <IsFree>boolean</IsFree>
        </ConcurrencyData>
      </GetPlaybackContextResult>
    </GetPlaybackContextResponse>
  </soap12:Body>
</soap12:Envelope>