BrightofficeAPI

Click here for a complete list of operations.

GetAllCompanies

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
userName:
getUserReportInfo:
getDatabaseIndexViews:
enableDbSize:
enableDocSize:

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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetAllCompanies"

<?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>
    <GetAllCompanies xmlns="http://tempuri.org/">
      <userName>string</userName>
      <getUserReportInfo>boolean</getUserReportInfo>
      <getDatabaseIndexViews>boolean</getDatabaseIndexViews>
      <enableDbSize>boolean</enableDbSize>
      <enableDocSize>boolean</enableDocSize>
    </GetAllCompanies>
  </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>
    <GetAllCompaniesResponse xmlns="http://tempuri.org/">
      <GetAllCompaniesResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </GetAllCompaniesResult>
    </GetAllCompaniesResponse>
  </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 /Webservices/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
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>
    <GetAllCompanies xmlns="http://tempuri.org/">
      <userName>string</userName>
      <getUserReportInfo>boolean</getUserReportInfo>
      <getDatabaseIndexViews>boolean</getDatabaseIndexViews>
      <enableDbSize>boolean</enableDbSize>
      <enableDocSize>boolean</enableDocSize>
    </GetAllCompanies>
  </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>
    <GetAllCompaniesResponse xmlns="http://tempuri.org/">
      <GetAllCompaniesResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </GetAllCompaniesResult>
    </GetAllCompaniesResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /Webservices/BrightOfficeAPI.asmx/GetAllCompanies?userName=string&getUserReportInfo=string&getDatabaseIndexViews=string&enableDbSize=string&enableDocSize=string HTTP/1.1
Host: www.spdoffice.co.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<EnquiryListResult xmlns="http://tempuri.org/">
  <EnquiryResult>
    <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
    <Message>string</Message>
    <ExceptionMessage>string</ExceptionMessage>
    <IsSystemError>boolean</IsSystemError>
  </EnquiryResult>
  <Records>
    <anyType />
    <anyType />
  </Records>
  <TotalRecordCount>int</TotalRecordCount>
</EnquiryListResult>

HTTP POST

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

POST /Webservices/BrightOfficeAPI.asmx/GetAllCompanies HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&getUserReportInfo=string&getDatabaseIndexViews=string&enableDbSize=string&enableDocSize=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<EnquiryListResult xmlns="http://tempuri.org/">
  <EnquiryResult>
    <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
    <Message>string</Message>
    <ExceptionMessage>string</ExceptionMessage>
    <IsSystemError>boolean</IsSystemError>
  </EnquiryResult>
  <Records>
    <anyType />
    <anyType />
  </Records>
  <TotalRecordCount>int</TotalRecordCount>
</EnquiryListResult>