API Web Service

API

Click here for a complete list of operations.

GetKSQLChannels

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

<?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>
    <GetKSQLChannels xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
    </GetKSQLChannels>
  </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>
    <GetKSQLChannelsResponse xmlns="http://api.tvinci.com/">
      <GetKSQLChannelsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Channels>
          <KSQLChannel>
            <ID>int</ID>
            <GroupID>int</GroupID>
            <IsActive>int</IsActive>
            <Status>int</Status>
            <AssetTypes xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <Order xsi:nil="true" />
            <FilterQuery>string</FilterQuery>
            <filterTree xsi:nil="true" />
            <GroupBy>string</GroupBy>
          </KSQLChannel>
          <KSQLChannel>
            <ID>int</ID>
            <GroupID>int</GroupID>
            <IsActive>int</IsActive>
            <Status>int</Status>
            <AssetTypes xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <Order xsi:nil="true" />
            <FilterQuery>string</FilterQuery>
            <filterTree xsi:nil="true" />
            <GroupBy>string</GroupBy>
          </KSQLChannel>
        </Channels>
      </GetKSQLChannelsResult>
    </GetKSQLChannelsResponse>
  </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>
    <GetKSQLChannels xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
    </GetKSQLChannels>
  </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>
    <GetKSQLChannelsResponse xmlns="http://api.tvinci.com/">
      <GetKSQLChannelsResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <Channels>
          <KSQLChannel>
            <ID>int</ID>
            <GroupID>int</GroupID>
            <IsActive>int</IsActive>
            <Status>int</Status>
            <AssetTypes xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <Order xsi:nil="true" />
            <FilterQuery>string</FilterQuery>
            <filterTree xsi:nil="true" />
            <GroupBy>string</GroupBy>
          </KSQLChannel>
          <KSQLChannel>
            <ID>int</ID>
            <GroupID>int</GroupID>
            <IsActive>int</IsActive>
            <Status>int</Status>
            <AssetTypes xsi:nil="true" />
            <Name>string</Name>
            <Description>string</Description>
            <Order xsi:nil="true" />
            <FilterQuery>string</FilterQuery>
            <filterTree xsi:nil="true" />
            <GroupBy>string</GroupBy>
          </KSQLChannel>
        </Channels>
      </GetKSQLChannelsResult>
    </GetKSQLChannelsResponse>
  </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/GetKSQLChannels 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"?>
<KSQLChannelResponseList 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>
  <Channels>
    <KSQLChannel>
      <ID>int</ID>
      <GroupID>int</GroupID>
      <IsActive>int</IsActive>
      <Status>int</Status>
      <AssetTypes>
        <int>int</int>
        <int>int</int>
      </AssetTypes>
      <Name>string</Name>
      <Description>string</Description>
      <Order>
        <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>
      </Order>
      <FilterQuery>string</FilterQuery>
      <filterTree />
      <GroupBy>string</GroupBy>
    </KSQLChannel>
    <KSQLChannel>
      <ID>int</ID>
      <GroupID>int</GroupID>
      <IsActive>int</IsActive>
      <Status>int</Status>
      <AssetTypes>
        <int>int</int>
        <int>int</int>
      </AssetTypes>
      <Name>string</Name>
      <Description>string</Description>
      <Order>
        <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>
      </Order>
      <FilterQuery>string</FilterQuery>
      <filterTree />
      <GroupBy>string</GroupBy>
    </KSQLChannel>
  </Channels>
</KSQLChannelResponseList>

Parameter	Value
sWSUserName:
sWSPassword: