DSN Manager - GetODBCDSNs

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName

• OptionalParam

• DSNName

• WebsiteName

• Language
   

Output Parameters

• DSNID

• DSNName

• DriverType - Microsoft Access Driver/Microsoft Excel Driver/Microsoft Visual Foxpro Driver / SQL Server / MySQL

• Owner

• AssociatedWebsite

• ColdFusionMX

 Sample Optional Parameters

<Parameters>

<Parameter Name = "DSNName">MyDSN</Parameter>

<Parameter Name = "WebsiteName">MyDomain.com</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/GetODBCDSNs"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetODBCDSNs>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

{

         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 = "DSNName";

                    xParameter.Attributes.Append(xAttribute);

                    xParameter.InnerText = "MyDSN";

                    xOptionalParam.AppendChild(xParameter);

                    .......

                    .......

                    .......

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

                    OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetODBCDSNs</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>           

    <Result>

        <ODBCDSNs xmlns="">

            <RecordRow>

                <DSNID>1</DSNID>

                <DSNName>MyDSN</DSNName>

                <DriverType>Microsoft Excel Driver</DriverType>

                <Owner>david</Owner>

                <AssociatedWebsite>MyDomain.com</AssociatedWebsite>

                <ColdFusionMX>False</ColdFusionMX>

            </RecordRow>

                  .......

                  .......

                  .......

        </ODBCDSNs>

    </Result>

</Response>