AOEOOHostWebServices


Click here for a complete list of operations.

GetConnection

This method receives the id of the SaaS data file the user needs to connect to and returns the Connection in the BQConnection object.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AOEOOHostWebServices.asmx HTTP/1.1
Host: aoo-srv01-iad-hws.archiofficeonline.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ArchiOfficeOnlineHost/GetConnection"

<?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>
    <GetConnection xmlns="http://ArchiOfficeOnlineHost/">
      <dbFileName>string</dbFileName>
    </GetConnection>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetConnectionResponse xmlns="http://ArchiOfficeOnlineHost/">
      <GetConnectionResult>
        <DBUserID>string</DBUserID>
        <DBPassword>string</DBPassword>
        <ConnectionString>string</ConnectionString>
        <DbFile>string</DbFile>
        <Server>string</Server>
        <Message>string</Message>
        <CompanyName>string</CompanyName>
        <AccountID>string</AccountID>
        <HasMultipleDB>boolean</HasMultipleDB>
        <EP>string</EP>
        <Version>string</Version>
        <CoreAppAPIURL>string</CoreAppAPIURL>
        <CoreDBAPIURL>string</CoreDBAPIURL>
      </GetConnectionResult>
    </GetConnectionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AOEOOHostWebServices.asmx HTTP/1.1
Host: aoo-srv01-iad-hws.archiofficeonline.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetConnection xmlns="http://ArchiOfficeOnlineHost/">
      <dbFileName>string</dbFileName>
    </GetConnection>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetConnectionResponse xmlns="http://ArchiOfficeOnlineHost/">
      <GetConnectionResult>
        <DBUserID>string</DBUserID>
        <DBPassword>string</DBPassword>
        <ConnectionString>string</ConnectionString>
        <DbFile>string</DbFile>
        <Server>string</Server>
        <Message>string</Message>
        <CompanyName>string</CompanyName>
        <AccountID>string</AccountID>
        <HasMultipleDB>boolean</HasMultipleDB>
        <EP>string</EP>
        <Version>string</Version>
        <CoreAppAPIURL>string</CoreAppAPIURL>
        <CoreDBAPIURL>string</CoreDBAPIURL>
      </GetConnectionResult>
    </GetConnectionResponse>
  </soap12:Body>
</soap12:Envelope>