Domain Properties - GetCustomError

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Domain Properties - GetCustomError retrieves details of a specified HTTP error. This web service call can be made as http://your-domain.com/HC7API/DomainProperties.asmx?op=GetCustomError.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• HTTPError

• WebsiteName

• OptionalParam

• ErrorSubCode

• Language

Output Parameters

• HTTPError

• ErrorSubcode

• Type - Default / File / URL

• Contents

• Description

Sample Optional Parameters

<Parameters>

<Parameter Name = "ErrorSubCode">1</Parameter>

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

</Parameters>

Sample SOAP Request

POST /HC7API/DomainProperties.asmx HTTP/1.1

Host: your-domain.com

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

Content-Length: length

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <WebsiteName>MyDomain.com</WebsiteName>

      <OptionalParam>xml</OptionalParam>

    </GetCustomError>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DomainProperties.asmx/GetCustomError 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 DomainProperties.Response GetCustomError(string strHostUserName, string strHostPassword, string strOwnerName, string strWebsiteName)

{

         try

         {

                   DomainProperties.DomainProperties oDomain = new DomainProperties.DomainProperties();

                   DomainProperties.Response oResponse = new DomainProperties.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 = "ErrorSubCode";

                   xParameter.Attributes.Append(xAttribute);

                   xParameter.InnerText = "1";

                   xOptionalParam.AppendChild(xParameter);

                   .......

                   .......

                   .......

                   oResponse = oDomain.GetCustomError(strHostUserName, strHostPassword, strOwnerName,  

                   strWebsiteName, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetCustomError</ Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

       <CustomError xmlns="">

          <HTTPError>400</HTTPError>

          <ErrorSubcode>1</ErrorSubcode>

          <Type>File</Type>

          <Contents>C:\WINDOWS\help\iisHelp\common\401-1.htm</Contents>

          <Description>Unauthorized Logon failed</Description>

        </CustomError>

    </Result>

</Response>