API Web Service

API

Click here for a complete list of operations.

SearchAssets

Test

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

Parameter	Value
username:
password:
filter:
pageIndex:
pageSize:
OnlyIsActive:
languageID:
UseStartDate:
Udid:
UserIP:
SiteGuid:
DomainId:
ExectGroupId:
IgnoreDeviceRule:

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

<?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>
    <SearchAssets xmlns="http://api.tvinci.com/">
      <username>string</username>
      <password>string</password>
      <filter>string</filter>
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <OnlyIsActive>boolean</OnlyIsActive>
      <languageID>int</languageID>
      <UseStartDate>boolean</UseStartDate>
      <Udid>string</Udid>
      <UserIP>string</UserIP>
      <SiteGuid>string</SiteGuid>
      <DomainId>int</DomainId>
      <ExectGroupId>int</ExectGroupId>
      <IgnoreDeviceRule>boolean</IgnoreDeviceRule>
    </SearchAssets>
  </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>
    <SearchAssetsResponse xmlns="http://api.tvinci.com/">
      <SearchAssetsResult>
        <UnifiedSearchResult>
          <Score>double</Score>
        </UnifiedSearchResult>
        <UnifiedSearchResult>
          <Score>double</Score>
        </UnifiedSearchResult>
      </SearchAssetsResult>
    </SearchAssetsResponse>
  </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>
    <SearchAssets xmlns="http://api.tvinci.com/">
      <username>string</username>
      <password>string</password>
      <filter>string</filter>
      <pageIndex>int</pageIndex>
      <pageSize>int</pageSize>
      <OnlyIsActive>boolean</OnlyIsActive>
      <languageID>int</languageID>
      <UseStartDate>boolean</UseStartDate>
      <Udid>string</Udid>
      <UserIP>string</UserIP>
      <SiteGuid>string</SiteGuid>
      <DomainId>int</DomainId>
      <ExectGroupId>int</ExectGroupId>
      <IgnoreDeviceRule>boolean</IgnoreDeviceRule>
    </SearchAssets>
  </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>
    <SearchAssetsResponse xmlns="http://api.tvinci.com/">
      <SearchAssetsResult>
        <UnifiedSearchResult>
          <Score>double</Score>
        </UnifiedSearchResult>
        <UnifiedSearchResult>
          <Score>double</Score>
        </UnifiedSearchResult>
      </SearchAssetsResult>
    </SearchAssetsResponse>
  </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/SearchAssets HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&filter=string&pageIndex=string&pageSize=string&OnlyIsActive=string&languageID=string&UseStartDate=string&Udid=string&UserIP=string&SiteGuid=string&DomainId=string&ExectGroupId=string&IgnoreDeviceRule=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUnifiedSearchResult xmlns="http://api.tvinci.com/">
  <UnifiedSearchResult>
    <Score>double</Score>
  </UnifiedSearchResult>
  <UnifiedSearchResult>
    <Score>double</Score>
  </UnifiedSearchResult>
</ArrayOfUnifiedSearchResult>