DSN Manager - AddODBCDSN

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

DSN Manager - AddODBCDSN retrieves ODBC DSN under a  specified owner. This web service call can be made as http://your-domain.com/HC7API/DSNManager.asmx?op=AddODBCDSN.

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• DSNName

• DriverType - Microsoft Access Driver / Microsoft Excel Driver / Microsoft Visual Foxpro Driver

• WebsiteName

• OptionalParam

• EnableCFMX

• Username                      

• UserPassword

• Description
  
  File Based DSN

• FilePath -  if Driver Type is file based, then this parameter will act as required parameter
  
  SQL Server

• DatabaseName - existing SQL Server database; if Driver Type is SQL Server, then this parameter will act as required parameter

• HostName - database instance name; if Driver Type is SQL Server, then this parameter will act as required parameter
  
  MySQL

• DatabaseName - existing MySQL database name; if Driver Type is MySQL then this parameter will act as required parameter

• HostName - database instance name; if Driver Type is MySQL, then this parameter will act as required parameter

• Port - default value is 3306

• CommandOnConnect

• DontOptimizeColumnWidth

• ReturnMatchingRows

• TraceMyODBC

• AllowBigResults

• DontPromptOnConnect

• SimulateODBC

• IgnoreInNoTable

• UseManagerCursor

• DontUseSetLocal

• PADCharToFullLength

• ReturnTableName

• UseCompressedProtocol

• IgnoreSpaceAfterFunc

• ForceUseOfNamedPipes

• ChangeBigIntToInt

• NoCatalog

• ReadOptionFromMyCnf

• Safety

• DisableTranslations

• Language 
   

Output Parameters

         N/A

Sample Optional Parameters

<Parameters>

<Parameter Name = "DontOptimizeColumnWidth">True</Parameter>

<Parameter Name = "ReturnMatchingRows">True</Parameter>

<Parameter Name = "IgnoreInNoTable">False</Parameter>

<Parameter Name = "UserManagerCursor">True</Parameter>

<Parameter Name = "IgnoreSpaceAfterFunc">False</Parameter>

<Parameter Name = "ReadOptionFromMyCnf">False</Parameter>

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

</Parameters>

Sample SOAP Request

POST /HC7API/DSNManager.asmx HTTP/1.1

Host: your-domain.com

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

Content-Length: length

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <DSNName>MyDSN</DSNName>

      <DriverType>Microsoft Excel Driver</DriverType>

      <WebsiteName>MyDomain.com</WebsiteName>

      <OptionalParam>xml</OptionalParam>

    </AddODBCDSN>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/DSNManager.asmx/AddODBCDSN HTTP/1.1

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&DSNName=MyDSN&DriverType=

MicrosoftExcelDriver&WebsiteName=MyDomain.com&OptionalParam=xml

Sample C# Code

public DSNManager.Response AddODBCDSN(string strHostUserName, string strHostPassword, string strOwnerName, string strDSNName, string strDriverType, string strWebsiteName)

{

         try

         {

                    DSNManager.DSNManager oDSN = new DSNManager.DSNManager();

                    DSNManager.Response oResponse = new DSNManager.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 = "DontOptimizeColumnWidth";

                    xParameter.Attributes.Append(xAttribute);

                    xParameter.InnerText = "True";

                    xOptionalParam.AppendChild(xParameter);

                    .......

                    .......

                    .......

                    oResponse = oDSN.AddODBCDSN(strHostUserName, strHostPassword, strOwnerName,   

                    strDSNName,strDriverType, strWebsiteName, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>AddODBCDSN</Method>

    <Status>true</Status>

    <ErrorCode>70600011</ErrorCode>

    <ErrorDescription>ODBC DSN added successfully.</ErrorDescription>           

    <Result/>

</Response>