BrightofficeAPI

Click here for a complete list of operations.

GetDataAnalyticsbyModule

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 /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/GetDataAnalyticsbyModule"

<?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>
    <GetDataAnalyticsbyModule xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <Options>
        <ModuleName>
          <string>string</string>
          <string>string</string>
        </ModuleName>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <Parameter>
          <KeyValueOption>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueOption>
          <KeyValueOption>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueOption>
        </Parameter>
      </Options>
    </GetDataAnalyticsbyModule>
  </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>
    <GetDataAnalyticsbyModuleResponse xmlns="http://tempuri.org/">
      <GetDataAnalyticsbyModuleResult>
        <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>
      </GetDataAnalyticsbyModuleResult>
    </GetDataAnalyticsbyModuleResponse>
  </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>
    <GetDataAnalyticsbyModule xmlns="http://tempuri.org/">
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
      <Options>
        <ModuleName>
          <string>string</string>
          <string>string</string>
        </ModuleName>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <Parameter>
          <KeyValueOption>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueOption>
          <KeyValueOption>
            <Key>string</Key>
            <Value>string</Value>
          </KeyValueOption>
        </Parameter>
      </Options>
    </GetDataAnalyticsbyModule>
  </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>
    <GetDataAnalyticsbyModuleResponse xmlns="http://tempuri.org/">
      <GetDataAnalyticsbyModuleResult>
        <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>
      </GetDataAnalyticsbyModuleResult>
    </GetDataAnalyticsbyModuleResponse>
  </soap12:Body>
</soap12:Envelope>