Index Server Manager - ScanCatalog

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Index Server Manager - ScanCatalog  scans catalog on your website. This web service call can be made as http://your-domain.com/HC7API/IndexServerManager.asmx?op=ScanCatalog.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• WebsiteName

• OptionalParam

• ScanType - Incremental Scan / Full Scan, default scan will be incremental

• Language

Output Parameters

        N/A

Sample Optional Parameters

<Parameters>

<Parameter Name = "ScanType">Incremental Scan</Parameter>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/IndexServerManager.asmx HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/ScanCatalog"

<?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>

    <ScanCatalog xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <WebsiteName>MyDomain.com</WebsiteName>

      <OptionalParam>xml</OptionalParam>

    </ScanCatalog>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/IndexServerManager.asmx/ScanCatalog HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&WebsiteName=MyDomain.com&

OptionalParam=xml

Sample C# Code

public IndexServerManager.Response ScanCatalog(string strHostUserName, string strHostPassword, string strOwnerName, string strWebsiteName)

{

         try

         {

                    IndexServerManager.IndexServerManager oIndexServer =

                    new IndexServerManager.IndexServerManager();

                    IndexServerManager.Response oResponse = new IndexServerManager.Response();

  XmlDocument oDoc = new XmlDocument();

  //Adding root node

  XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");

  //Adding sub nodes

  XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");

  XmlAttribute xAttribute = oDoc.CreateAttribute("Name");

  xAttribute.Value = "ScanType";

  xParameter.Attributes.Append(xAttribute);

  xParameter.InnerText = "Full Scan";

  xOptionalParam.AppendChild(xParameter);

  .......

  .......

  .......

                    oResponse = oIndexServer.ScanCatalog(strHostUserName, strHostPassword, strOwnerName,

                    strWebsiteName, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>ScanCatalog</Method>

    <Status>true</Status>

    <ErrorCode>70400051</ErrorCode>

    <ErrorDescription>Catalog rescanned successfully.</ErrorDescription>           

    <Result/>

</Response>