API


Click here for a complete list of operations.

SetRecommendationEngine

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 /restful_v5_2_8/api.asmx HTTP/1.1
Host: kbcsony.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tvinci.com/SetRecommendationEngine"

<?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>
    <SetRecommendationEngine xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <recommendationEngine>
        <ID>int</ID>
        <Name>string</Name>
        <IsDefault>boolean</IsDefault>
        <IsActive>boolean</IsActive>
        <AdapterUrl>string</AdapterUrl>
        <ExternalIdentifier>string</ExternalIdentifier>
        <SharedSecret>string</SharedSecret>
        <Settings>
          <RecommendationEngineSettings>
            <key>string</key>
            <value>string</value>
          </RecommendationEngineSettings>
          <RecommendationEngineSettings>
            <key>string</key>
            <value>string</value>
          </RecommendationEngineSettings>
        </Settings>
        <SkipSettings>boolean</SkipSettings>
      </recommendationEngine>
    </SetRecommendationEngine>
  </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>
    <SetRecommendationEngineResponse xmlns="http://api.tvinci.com/">
      <SetRecommendationEngineResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <RecommendationEngine>
          <ID>int</ID>
          <Name>string</Name>
          <IsDefault>boolean</IsDefault>
          <IsActive>boolean</IsActive>
          <AdapterUrl>string</AdapterUrl>
          <ExternalIdentifier>string</ExternalIdentifier>
          <SharedSecret>string</SharedSecret>
          <Settings>
            <RecommendationEngineSettings xsi:nil="true" />
            <RecommendationEngineSettings xsi:nil="true" />
          </Settings>
          <SkipSettings>boolean</SkipSettings>
        </RecommendationEngine>
      </SetRecommendationEngineResult>
    </SetRecommendationEngineResponse>
  </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 /restful_v5_2_8/api.asmx HTTP/1.1
Host: kbcsony.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>
    <SetRecommendationEngine xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <recommendationEngine>
        <ID>int</ID>
        <Name>string</Name>
        <IsDefault>boolean</IsDefault>
        <IsActive>boolean</IsActive>
        <AdapterUrl>string</AdapterUrl>
        <ExternalIdentifier>string</ExternalIdentifier>
        <SharedSecret>string</SharedSecret>
        <Settings>
          <RecommendationEngineSettings>
            <key>string</key>
            <value>string</value>
          </RecommendationEngineSettings>
          <RecommendationEngineSettings>
            <key>string</key>
            <value>string</value>
          </RecommendationEngineSettings>
        </Settings>
        <SkipSettings>boolean</SkipSettings>
      </recommendationEngine>
    </SetRecommendationEngine>
  </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>
    <SetRecommendationEngineResponse xmlns="http://api.tvinci.com/">
      <SetRecommendationEngineResult>
        <Status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </Status>
        <RecommendationEngine>
          <ID>int</ID>
          <Name>string</Name>
          <IsDefault>boolean</IsDefault>
          <IsActive>boolean</IsActive>
          <AdapterUrl>string</AdapterUrl>
          <ExternalIdentifier>string</ExternalIdentifier>
          <SharedSecret>string</SharedSecret>
          <Settings>
            <RecommendationEngineSettings xsi:nil="true" />
            <RecommendationEngineSettings xsi:nil="true" />
          </Settings>
          <SkipSettings>boolean</SkipSettings>
        </RecommendationEngine>
      </SetRecommendationEngineResult>
    </SetRecommendationEngineResponse>
  </soap12:Body>
</soap12:Envelope>