Database Manager - GetDatabases

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Database Manager - GetDatabases  retrieves databases under a specified owner. This web service call can be made as http://your-domain.com/HC7API/DatabaseManager.asmx?op=GetDatabases.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose databases you want to retrieve, can be set to Host Name for getting all records

• OptionalParam

• WebsiteName - sent when you want to get databases under a particular website

• DatabaseName - name of the database that you want to retrieve

• Language
   

Output Parameters

• DatabaseID - a unique identification number given to each database

• DatabaseName -  name of the database

• DatabaseType -  MS-SQL Server / MySQL

• Owner - Webadmin Name, returned if OwnerName parameter is set to Reseller Name

• Creator - Reseller Name, returned if OwnerName parameter is set to Host Name

• AssociatedWebsite -  the website this database belongs to

• ServerName - name of the server on which database domain is physically created

• ServerIP - IP of the sever on which the database is physically created

• Connectivity - localhost / 127.0.0.1:3306

Sample Optional Parameters

<Parameters>

<Parameter Name = "WebsiteName">MyDomain.com</Parameter>

<Parameter Name = "DatabaseName">MyDatabase</Parameter>

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

</Parameters>

Sample SOAP Request

POST /HC7API/DatabaseManager.asmx HTTP/1.1

Host: your-domain.com

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

Content-Length: length

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetDatabases>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DatabaseManager.asmx/GetDatabases HTTP/1.1

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&OptionalParam=xml

Sample C# Code

public DatabaseManager.Response GetDatabases(string strHostUserName, string strHostPassword, string strOwnerName)

{

          try

         {

                    DatabaseManager.DatabaseManager oDatabase = new DatabaseManager.DatabaseManager();

                    DatabaseManager.Response oResponse = new DatabaseManager.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 = "WebsiteName";

  xParameter.Attributes.Append(xAttribute);

  xParameter.InnerText = "MyDomain.com";

  xOptionalParam.AppendChild(xParameter);

  .......

  .......

  .......

                    oResponse = oDatabase.GetDatabases(strHostUserName, strHostPassword, strOwnerName,

                    OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetDatabases</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>           

    <Result/>

       <Databases xmlns="">

          <RecordCount>4</RecordCount>

             <RecordRow>

                <DatabaseID>470</DatabaseID>

                <DatabaseName>MyDatabase</DatabaseName>

                <DatabaseType>MySQL</DatabaseType>

                <Owner>david</Owner>

                <AssociatedWebsite>MyDomain.com</AssociatedWebsite>

                <ServerName>abc</ServerName>

                <ServerIP>127.0.0.1</ServerIP>

                <Connectivity>127.0.0.1:3306</Connectivity>

             </RecordRow>

                   .......

                   .......

                   .......            

          </Databases>

       </Result>

</Response>