API Web Service

API

Click here for a complete list of operations.

TVAPI_SearchMedia

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

<?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>
    <TVAPI_SearchMedia xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <oInitObj>
        <m_oPicObjects>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
        </m_oPicObjects>
        <m_oFileRequestObjects>
          <FileRequestObject>
            <m_sFileFormat>string</m_sFileFormat>
            <m_sFileQuality>string</m_sFileQuality>
          </FileRequestObject>
          <FileRequestObject>
            <m_sFileFormat>string</m_sFileFormat>
            <m_sFileQuality>string</m_sFileQuality>
          </FileRequestObject>
        </m_oFileRequestObjects>
        <m_oPlayerIMRequestObject>
          <m_sPalyerID>string</m_sPalyerID>
          <m_sPlayerKey>string</m_sPlayerKey>
        </m_oPlayerIMRequestObject>
        <m_oUserIMRequestObject>
          <m_sTvinciGuid>string</m_sTvinciGuid>
          <m_sSiteGuid>string</m_sSiteGuid>
          <m_sUserAgent>string</m_sUserAgent>
          <m_sUserIP>string</m_sUserIP>
        </m_oUserIMRequestObject>
        <m_oLanguageRequestObject>
          <m_sFullName>string</m_sFullName>
        </m_oLanguageRequestObject>
        <m_oExtraRequestObject>
          <m_bNoCache>boolean</m_bNoCache>
          <m_bZip>boolean</m_bZip>
          <m_bWithInfo>boolean</m_bWithInfo>
          <m_bWithFileTypes>boolean</m_bWithFileTypes>
          <m_bUseFinalEndDate>boolean</m_bUseFinalEndDate>
        </m_oExtraRequestObject>
        <m_sDevice>string</m_sDevice>
        <m_sAdminToken>string</m_sAdminToken>
      </oInitObj>
      <oSearchDefinitionObj>
        <m_sTitle>string</m_sTitle>
        <m_sDescription>string</m_sDescription>
        <m_sTypeName>string</m_sTypeName>
        <m_dMinDate>dateTime</m_dMinDate>
        <m_dMaxDate>dateTime</m_dMaxDate>
        <m_oTagObjects>
          <MetaM2MObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValues xsi:nil="true" />
            <m_nMetaID>int</m_nMetaID>
          </MetaM2MObject>
          <MetaM2MObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValues xsi:nil="true" />
            <m_nMetaID>int</m_nMetaID>
          </MetaM2MObject>
        </m_oTagObjects>
        <m_oMetaStrObjects>
          <MetaStrObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValue>string</m_sMetaValue>
          </MetaStrObject>
          <MetaStrObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValue>string</m_sMetaValue>
          </MetaStrObject>
        </m_oMetaStrObjects>
        <m_oMetaDoubleObjects>
          <MetaDoubleObject>
            <m_sMetaName>string</m_sMetaName>
            <m_dMetaValue>double</m_dMetaValue>
            <m_oDoubleRange xsi:nil="true" />
          </MetaDoubleObject>
          <MetaDoubleObject>
            <m_sMetaName>string</m_sMetaName>
            <m_dMetaValue>double</m_dMetaValue>
            <m_oDoubleRange xsi:nil="true" />
          </MetaDoubleObject>
        </m_oMetaDoubleObjects>
        <m_oMetaBoolObjects>
          <MetaBoolObject>
            <m_sMetaName>string</m_sMetaName>
            <m_bMetaValue>boolean</m_bMetaValue>
          </MetaBoolObject>
          <MetaBoolObject>
            <m_sMetaName>string</m_sMetaName>
            <m_bMetaValue>boolean</m_bMetaValue>
          </MetaBoolObject>
        </m_oMetaBoolObjects>
        <m_sOrderByObjects>
          <SearchOrderByObject>
            <m_eOrderBy>Desc or Asc</m_eOrderBy>
            <m_sOrderField>string</m_sOrderField>
            <m_nOrderNum>int</m_nOrderNum>
          </SearchOrderByObject>
          <SearchOrderByObject>
            <m_eOrderBy>Desc or Asc</m_eOrderBy>
            <m_sOrderField>string</m_sOrderField>
            <m_nOrderNum>int</m_nOrderNum>
          </SearchOrderByObject>
        </m_sOrderByObjects>
        <m_eAndOr>And or Or</m_eAndOr>
        <m_bExact>boolean</m_bExact>
        <m_oPageDefinition>
          <m_nStartIndex>int</m_nStartIndex>
          <m_nNumberOfItems>int</m_nNumberOfItems>
        </m_oPageDefinition>
      </oSearchDefinitionObj>
      <theInfoStruct>
        <m_bTitle>boolean</m_bTitle>
        <m_bDescription>boolean</m_bDescription>
        <m_bStatistics>boolean</m_bStatistics>
        <m_bPersonal>boolean</m_bPersonal>
        <m_bType>boolean</m_bType>
        <m_sMetaStrings>
          <string>string</string>
          <string>string</string>
        </m_sMetaStrings>
        <m_sMetaDoubles>
          <string>string</string>
          <string>string</string>
        </m_sMetaDoubles>
        <m_sMetaBools>
          <string>string</string>
          <string>string</string>
        </m_sMetaBools>
        <m_sTags>
          <string>string</string>
          <string>string</string>
        </m_sTags>
      </theInfoStruct>
    </TVAPI_SearchMedia>
  </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>
    <TVAPI_SearchMediaResponse xmlns="http://api.tvinci.com/">
      <TVAPI_SearchMediaResult>
        <m_oPlayListSchema>
          <m_nChannelID>int</m_nChannelID>
          <m_oPre>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oPre>
          <m_oPost>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oPost>
          <m_oBreak>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oBreak>
          <m_oOverlay>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oOverlay>
        </m_oPlayListSchema>
        <m_oMediaObjects>
          <MediaObject>
            <m_sOwnerGUID>string</m_sOwnerGUID>
            <m_nMediaID>int</m_nMediaID>
            <m_sTitle>string</m_sTitle>
            <m_sBlockType>string</m_sBlockType>
            <m_dPublishDate>dateTime</m_dPublishDate>
            <m_oMediaFiles xsi:nil="true" />
            <m_oPicPbjects xsi:nil="true" />
            <m_oMediaInfo xsi:nil="true" />
            <m_oMediaStatistics xsi:nil="true" />
            <m_oMediaPersonalStatistics xsi:nil="true" />
            <m_oAvailableFileTypes xsi:nil="true" />
          </MediaObject>
          <MediaObject>
            <m_sOwnerGUID>string</m_sOwnerGUID>
            <m_nMediaID>int</m_nMediaID>
            <m_sTitle>string</m_sTitle>
            <m_sBlockType>string</m_sBlockType>
            <m_dPublishDate>dateTime</m_dPublishDate>
            <m_oMediaFiles xsi:nil="true" />
            <m_oPicPbjects xsi:nil="true" />
            <m_oMediaInfo xsi:nil="true" />
            <m_oMediaStatistics xsi:nil="true" />
            <m_oMediaPersonalStatistics xsi:nil="true" />
            <m_oAvailableFileTypes xsi:nil="true" />
          </MediaObject>
        </m_oMediaObjects>
        <m_nChannelTotalSize>int</m_nChannelTotalSize>
        <m_oPicObjects>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
        </m_oPicObjects>
        <m_sTitle>string</m_sTitle>
        <m_sDescription>string</m_sDescription>
        <m_sEditorRemarks>string</m_sEditorRemarks>
        <m_nID>int</m_nID>
      </TVAPI_SearchMediaResult>
    </TVAPI_SearchMediaResponse>
  </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>
    <TVAPI_SearchMedia xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <oInitObj>
        <m_oPicObjects>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
        </m_oPicObjects>
        <m_oFileRequestObjects>
          <FileRequestObject>
            <m_sFileFormat>string</m_sFileFormat>
            <m_sFileQuality>string</m_sFileQuality>
          </FileRequestObject>
          <FileRequestObject>
            <m_sFileFormat>string</m_sFileFormat>
            <m_sFileQuality>string</m_sFileQuality>
          </FileRequestObject>
        </m_oFileRequestObjects>
        <m_oPlayerIMRequestObject>
          <m_sPalyerID>string</m_sPalyerID>
          <m_sPlayerKey>string</m_sPlayerKey>
        </m_oPlayerIMRequestObject>
        <m_oUserIMRequestObject>
          <m_sTvinciGuid>string</m_sTvinciGuid>
          <m_sSiteGuid>string</m_sSiteGuid>
          <m_sUserAgent>string</m_sUserAgent>
          <m_sUserIP>string</m_sUserIP>
        </m_oUserIMRequestObject>
        <m_oLanguageRequestObject>
          <m_sFullName>string</m_sFullName>
        </m_oLanguageRequestObject>
        <m_oExtraRequestObject>
          <m_bNoCache>boolean</m_bNoCache>
          <m_bZip>boolean</m_bZip>
          <m_bWithInfo>boolean</m_bWithInfo>
          <m_bWithFileTypes>boolean</m_bWithFileTypes>
          <m_bUseFinalEndDate>boolean</m_bUseFinalEndDate>
        </m_oExtraRequestObject>
        <m_sDevice>string</m_sDevice>
        <m_sAdminToken>string</m_sAdminToken>
      </oInitObj>
      <oSearchDefinitionObj>
        <m_sTitle>string</m_sTitle>
        <m_sDescription>string</m_sDescription>
        <m_sTypeName>string</m_sTypeName>
        <m_dMinDate>dateTime</m_dMinDate>
        <m_dMaxDate>dateTime</m_dMaxDate>
        <m_oTagObjects>
          <MetaM2MObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValues xsi:nil="true" />
            <m_nMetaID>int</m_nMetaID>
          </MetaM2MObject>
          <MetaM2MObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValues xsi:nil="true" />
            <m_nMetaID>int</m_nMetaID>
          </MetaM2MObject>
        </m_oTagObjects>
        <m_oMetaStrObjects>
          <MetaStrObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValue>string</m_sMetaValue>
          </MetaStrObject>
          <MetaStrObject>
            <m_sMetaName>string</m_sMetaName>
            <m_sMetaValue>string</m_sMetaValue>
          </MetaStrObject>
        </m_oMetaStrObjects>
        <m_oMetaDoubleObjects>
          <MetaDoubleObject>
            <m_sMetaName>string</m_sMetaName>
            <m_dMetaValue>double</m_dMetaValue>
            <m_oDoubleRange xsi:nil="true" />
          </MetaDoubleObject>
          <MetaDoubleObject>
            <m_sMetaName>string</m_sMetaName>
            <m_dMetaValue>double</m_dMetaValue>
            <m_oDoubleRange xsi:nil="true" />
          </MetaDoubleObject>
        </m_oMetaDoubleObjects>
        <m_oMetaBoolObjects>
          <MetaBoolObject>
            <m_sMetaName>string</m_sMetaName>
            <m_bMetaValue>boolean</m_bMetaValue>
          </MetaBoolObject>
          <MetaBoolObject>
            <m_sMetaName>string</m_sMetaName>
            <m_bMetaValue>boolean</m_bMetaValue>
          </MetaBoolObject>
        </m_oMetaBoolObjects>
        <m_sOrderByObjects>
          <SearchOrderByObject>
            <m_eOrderBy>Desc or Asc</m_eOrderBy>
            <m_sOrderField>string</m_sOrderField>
            <m_nOrderNum>int</m_nOrderNum>
          </SearchOrderByObject>
          <SearchOrderByObject>
            <m_eOrderBy>Desc or Asc</m_eOrderBy>
            <m_sOrderField>string</m_sOrderField>
            <m_nOrderNum>int</m_nOrderNum>
          </SearchOrderByObject>
        </m_sOrderByObjects>
        <m_eAndOr>And or Or</m_eAndOr>
        <m_bExact>boolean</m_bExact>
        <m_oPageDefinition>
          <m_nStartIndex>int</m_nStartIndex>
          <m_nNumberOfItems>int</m_nNumberOfItems>
        </m_oPageDefinition>
      </oSearchDefinitionObj>
      <theInfoStruct>
        <m_bTitle>boolean</m_bTitle>
        <m_bDescription>boolean</m_bDescription>
        <m_bStatistics>boolean</m_bStatistics>
        <m_bPersonal>boolean</m_bPersonal>
        <m_bType>boolean</m_bType>
        <m_sMetaStrings>
          <string>string</string>
          <string>string</string>
        </m_sMetaStrings>
        <m_sMetaDoubles>
          <string>string</string>
          <string>string</string>
        </m_sMetaDoubles>
        <m_sMetaBools>
          <string>string</string>
          <string>string</string>
        </m_sMetaBools>
        <m_sTags>
          <string>string</string>
          <string>string</string>
        </m_sTags>
      </theInfoStruct>
    </TVAPI_SearchMedia>
  </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>
    <TVAPI_SearchMediaResponse xmlns="http://api.tvinci.com/">
      <TVAPI_SearchMediaResult>
        <m_oPlayListSchema>
          <m_nChannelID>int</m_nChannelID>
          <m_oPre>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oPre>
          <m_oPost>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oPost>
          <m_oBreak>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oBreak>
          <m_oOverlay>
            <m_sType>string</m_sType>
            <m_bSkip>boolean</m_bSkip>
            <m_nDelta>int</m_nDelta>
            <m_sImplType>string</m_sImplType>
            <m_sUrl>string</m_sUrl>
            <m_dStartSec>double</m_dStartSec>
            <m_sPoints>string</m_sPoints>
          </m_oOverlay>
        </m_oPlayListSchema>
        <m_oMediaObjects>
          <MediaObject>
            <m_sOwnerGUID>string</m_sOwnerGUID>
            <m_nMediaID>int</m_nMediaID>
            <m_sTitle>string</m_sTitle>
            <m_sBlockType>string</m_sBlockType>
            <m_dPublishDate>dateTime</m_dPublishDate>
            <m_oMediaFiles xsi:nil="true" />
            <m_oPicPbjects xsi:nil="true" />
            <m_oMediaInfo xsi:nil="true" />
            <m_oMediaStatistics xsi:nil="true" />
            <m_oMediaPersonalStatistics xsi:nil="true" />
            <m_oAvailableFileTypes xsi:nil="true" />
          </MediaObject>
          <MediaObject>
            <m_sOwnerGUID>string</m_sOwnerGUID>
            <m_nMediaID>int</m_nMediaID>
            <m_sTitle>string</m_sTitle>
            <m_sBlockType>string</m_sBlockType>
            <m_dPublishDate>dateTime</m_dPublishDate>
            <m_oMediaFiles xsi:nil="true" />
            <m_oPicPbjects xsi:nil="true" />
            <m_oMediaInfo xsi:nil="true" />
            <m_oMediaStatistics xsi:nil="true" />
            <m_oMediaPersonalStatistics xsi:nil="true" />
            <m_oAvailableFileTypes xsi:nil="true" />
          </MediaObject>
        </m_oMediaObjects>
        <m_nChannelTotalSize>int</m_nChannelTotalSize>
        <m_oPicObjects>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
          <PicObject>
            <m_nPicWidth>int</m_nPicWidth>
            <m_nPicHeight>int</m_nPicHeight>
            <m_oFileRequestObj xsi:nil="true" />
            <m_sPicURL>string</m_sPicURL>
            <m_nPicBrandHeight>int</m_nPicBrandHeight>
            <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType>
          </PicObject>
        </m_oPicObjects>
        <m_sTitle>string</m_sTitle>
        <m_sDescription>string</m_sDescription>
        <m_sEditorRemarks>string</m_sEditorRemarks>
        <m_nID>int</m_nID>
      </TVAPI_SearchMediaResult>
    </TVAPI_SearchMediaResponse>
  </soap12:Body>
</soap12:Envelope>