API

Click here for a complete list of operations.

SetExternalChannel

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

<?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>
    <SetExternalChannel xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <externalChannel>
        <Enrichments>
          <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
          <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
        </Enrichments>
        <ID>int</ID>
        <Name>string</Name>
        <ExternalIdentifier>string</ExternalIdentifier>
        <RecommendationEngineId>int</RecommendationEngineId>
        <IsActive>boolean</IsActive>
        <FilterExpression>string</FilterExpression>
        <AssetUserRuleId>long</AssetUserRuleId>
        <HasMetadata>boolean</HasMetadata>
      </externalChannel>
    </SetExternalChannel>
  </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>
    <SetExternalChannelResponse xmlns="http://api.tvinci.com/">
      <SetExternalChannelResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <ExternalChannel>
          <Enrichments>
            <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
            <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
          </Enrichments>
          <ID>int</ID>
          <Name>string</Name>
          <ExternalIdentifier>string</ExternalIdentifier>
          <RecommendationEngineId>int</RecommendationEngineId>
          <IsActive>boolean</IsActive>
          <FilterExpression>string</FilterExpression>
          <AssetUserRuleId>long</AssetUserRuleId>
          <HasMetadata>boolean</HasMetadata>
        </ExternalChannel>
      </SetExternalChannelResult>
    </SetExternalChannelResponse>
  </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>
    <SetExternalChannel xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <externalChannel>
        <Enrichments>
          <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
          <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
        </Enrichments>
        <ID>int</ID>
        <Name>string</Name>
        <ExternalIdentifier>string</ExternalIdentifier>
        <RecommendationEngineId>int</RecommendationEngineId>
        <IsActive>boolean</IsActive>
        <FilterExpression>string</FilterExpression>
        <AssetUserRuleId>long</AssetUserRuleId>
        <HasMetadata>boolean</HasMetadata>
      </externalChannel>
    </SetExternalChannel>
  </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>
    <SetExternalChannelResponse xmlns="http://api.tvinci.com/">
      <SetExternalChannelResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <ExternalChannel>
          <Enrichments>
            <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
            <ExternalRecommendationEngineEnrichment>ClientLocation or UserId or HouseholdId or DeviceId or DeviceType or UTCOffset or Language or DTTRegion</ExternalRecommendationEngineEnrichment>
          </Enrichments>
          <ID>int</ID>
          <Name>string</Name>
          <ExternalIdentifier>string</ExternalIdentifier>
          <RecommendationEngineId>int</RecommendationEngineId>
          <IsActive>boolean</IsActive>
          <FilterExpression>string</FilterExpression>
          <AssetUserRuleId>long</AssetUserRuleId>
          <HasMetadata>boolean</HasMetadata>
        </ExternalChannel>
      </SetExternalChannelResult>
    </SetExternalChannelResponse>
  </soap12:Body>
</soap12:Envelope>