BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

GetCompany

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

<?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>
    <GetCompany xmlns="http://tempuri.org/">
      <CompanyReference>int</CompanyReference>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetCompany>
  </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>
    <GetCompanyResponse xmlns="http://tempuri.org/">
      <GetCompanyResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Company>
          <CompanyID>int</CompanyID>
          <CompanyName>string</CompanyName>
          <CompanyServerName>string</CompanyServerName>
          <ActiveCompany>boolean</ActiveCompany>
          <ActiveBackUp>boolean</ActiveBackUp>
          <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
          <SalesInvoices>int</SalesInvoices>
          <StaffUsers>int</StaffUsers>
          <NonStaffUsers>int</NonStaffUsers>
          <TotalEmailVerification>int</TotalEmailVerification>
          <TotalPrevAML>int</TotalPrevAML>
          <TotalPrevCredit>int</TotalPrevCredit>
          <TotalPrevAMLCredit>int</TotalPrevAMLCredit>
          <TotalSMS>int</TotalSMS>
          <PrevMonthTotalSMS>int</PrevMonthTotalSMS>
          <CurrentMonthTotalSMS>int</CurrentMonthTotalSMS>
          <PrevMonthInternationalSMS>int</PrevMonthInternationalSMS>
          <CurrentMonthInternationalSMS>int</CurrentMonthInternationalSMS>
          <ClientsLast3Days>int</ClientsLast3Days>
          <ClientsLast7Days>int</ClientsLast7Days>
          <ClientsLast30Days>int</ClientsLast30Days>
          <Edraw>string</Edraw>
          <Twain>string</Twain>
          <DataBaseName>string</DataBaseName>
          <ApplicationMode>string</ApplicationMode>
          <StaffUsersCount>int</StaffUsersCount>
          <StaffUsersLoginLast60Days>int</StaffUsersLoginLast60Days>
          <SourceUsersCount>int</SourceUsersCount>
          <FunderUsersCount>int</FunderUsersCount>
          <SolictorUsersCount>int</SolictorUsersCount>
          <PreviousMonthsNewUsers>int</PreviousMonthsNewUsers>
          <PreviousMonthsRemovedUsers>int</PreviousMonthsRemovedUsers>
          <CurrentMonthNewUsers>int</CurrentMonthNewUsers>
          <CurrentMonthRemovedUsers>int</CurrentMonthRemovedUsers>
          <CurrentMonthRemovedUsersARCHIVED>int</CurrentMonthRemovedUsersARCHIVED>
          <CurrentMonthRemovedUsersACTIVE>int</CurrentMonthRemovedUsersACTIVE>
          <PreviousMonthsRemovedUsersARCHIVED>int</PreviousMonthsRemovedUsersARCHIVED>
          <PreviousMonthsRemovedUsersACTIVE>int</PreviousMonthsRemovedUsersACTIVE>
          <IndexList>
            <Index xsi:nil="true" />
            <Index xsi:nil="true" />
          </IndexList>
          <ViewList>
            <ViewColumnRecord xsi:nil="true" />
            <ViewColumnRecord xsi:nil="true" />
          </ViewList>
          <BusinessMode>string</BusinessMode>
          <DatabaseSize>decimal</DatabaseSize>
          <DocumentsSize>decimal</DocumentsSize>
          <BrowserTitle>string</BrowserTitle>
          <CssFile>string</CssFile>
          <NasStorage>boolean</NasStorage>
          <WelcomeText>string</WelcomeText>
          <OverrideSQLSALogin>string</OverrideSQLSALogin>
          <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
          <UserReportLocation>string</UserReportLocation>
          <BrightOfficeInternal>boolean</BrightOfficeInternal>
          <AsposeVersion>string</AsposeVersion>
          <UAReference>string</UAReference>
          <WordLocation>string</WordLocation>
          <ExcelLocation>string</ExcelLocation>
          <PersonalLocation>string</PersonalLocation>
          <ImagesLocation>string</ImagesLocation>
          <CorrespondanceLocation>string</CorrespondanceLocation>
          <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
          <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
          <PDF>string</PDF>
          <BrightOffice>string</BrightOffice>
          <ftphost>string</ftphost>
          <ftpuser>string</ftpuser>
          <ftppass>string</ftppass>
          <ftppath>string</ftppath>
          <SecureFtpTransfer>boolean</SecureFtpTransfer>
          <MarkForDelete>boolean</MarkForDelete>
          <ftppasive>boolean</ftppasive>
          <FrequencyValue>string</FrequencyValue>
          <Frequency>string</Frequency>
          <LastRun>string</LastRun>
          <NextRun>string</NextRun>
          <MainLogoImage>string</MainLogoImage>
          <BottomLogoImage>string</BottomLogoImage>
          <BobbyBright>boolean</BobbyBright>
          <EnableImportManagerTemplateTable>boolean</EnableImportManagerTemplateTable>
          <LoginMessageOn>boolean</LoginMessageOn>
          <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
          <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
          <EnableFormLoginPage>boolean</EnableFormLoginPage>
          <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
          <LoginPageLayout>string</LoginPageLayout>
          <LoginPageForm>string</LoginPageForm>
          <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
          <EmailComponent>string</EmailComponent>
          <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
          <Suspended>boolean</Suspended>
          <LastSuspendedTime>dateTime</LastSuspendedTime>
        </Company>
      </GetCompanyResult>
    </GetCompanyResponse>
  </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>
    <GetCompany xmlns="http://tempuri.org/">
      <CompanyReference>int</CompanyReference>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetCompany>
  </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>
    <GetCompanyResponse xmlns="http://tempuri.org/">
      <GetCompanyResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Company>
          <CompanyID>int</CompanyID>
          <CompanyName>string</CompanyName>
          <CompanyServerName>string</CompanyServerName>
          <ActiveCompany>boolean</ActiveCompany>
          <ActiveBackUp>boolean</ActiveBackUp>
          <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
          <SalesInvoices>int</SalesInvoices>
          <StaffUsers>int</StaffUsers>
          <NonStaffUsers>int</NonStaffUsers>
          <TotalEmailVerification>int</TotalEmailVerification>
          <TotalPrevAML>int</TotalPrevAML>
          <TotalPrevCredit>int</TotalPrevCredit>
          <TotalPrevAMLCredit>int</TotalPrevAMLCredit>
          <TotalSMS>int</TotalSMS>
          <PrevMonthTotalSMS>int</PrevMonthTotalSMS>
          <CurrentMonthTotalSMS>int</CurrentMonthTotalSMS>
          <PrevMonthInternationalSMS>int</PrevMonthInternationalSMS>
          <CurrentMonthInternationalSMS>int</CurrentMonthInternationalSMS>
          <ClientsLast3Days>int</ClientsLast3Days>
          <ClientsLast7Days>int</ClientsLast7Days>
          <ClientsLast30Days>int</ClientsLast30Days>
          <Edraw>string</Edraw>
          <Twain>string</Twain>
          <DataBaseName>string</DataBaseName>
          <ApplicationMode>string</ApplicationMode>
          <StaffUsersCount>int</StaffUsersCount>
          <StaffUsersLoginLast60Days>int</StaffUsersLoginLast60Days>
          <SourceUsersCount>int</SourceUsersCount>
          <FunderUsersCount>int</FunderUsersCount>
          <SolictorUsersCount>int</SolictorUsersCount>
          <PreviousMonthsNewUsers>int</PreviousMonthsNewUsers>
          <PreviousMonthsRemovedUsers>int</PreviousMonthsRemovedUsers>
          <CurrentMonthNewUsers>int</CurrentMonthNewUsers>
          <CurrentMonthRemovedUsers>int</CurrentMonthRemovedUsers>
          <CurrentMonthRemovedUsersARCHIVED>int</CurrentMonthRemovedUsersARCHIVED>
          <CurrentMonthRemovedUsersACTIVE>int</CurrentMonthRemovedUsersACTIVE>
          <PreviousMonthsRemovedUsersARCHIVED>int</PreviousMonthsRemovedUsersARCHIVED>
          <PreviousMonthsRemovedUsersACTIVE>int</PreviousMonthsRemovedUsersACTIVE>
          <IndexList>
            <Index xsi:nil="true" />
            <Index xsi:nil="true" />
          </IndexList>
          <ViewList>
            <ViewColumnRecord xsi:nil="true" />
            <ViewColumnRecord xsi:nil="true" />
          </ViewList>
          <BusinessMode>string</BusinessMode>
          <DatabaseSize>decimal</DatabaseSize>
          <DocumentsSize>decimal</DocumentsSize>
          <BrowserTitle>string</BrowserTitle>
          <CssFile>string</CssFile>
          <NasStorage>boolean</NasStorage>
          <WelcomeText>string</WelcomeText>
          <OverrideSQLSALogin>string</OverrideSQLSALogin>
          <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
          <UserReportLocation>string</UserReportLocation>
          <BrightOfficeInternal>boolean</BrightOfficeInternal>
          <AsposeVersion>string</AsposeVersion>
          <UAReference>string</UAReference>
          <WordLocation>string</WordLocation>
          <ExcelLocation>string</ExcelLocation>
          <PersonalLocation>string</PersonalLocation>
          <ImagesLocation>string</ImagesLocation>
          <CorrespondanceLocation>string</CorrespondanceLocation>
          <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
          <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
          <PDF>string</PDF>
          <BrightOffice>string</BrightOffice>
          <ftphost>string</ftphost>
          <ftpuser>string</ftpuser>
          <ftppass>string</ftppass>
          <ftppath>string</ftppath>
          <SecureFtpTransfer>boolean</SecureFtpTransfer>
          <MarkForDelete>boolean</MarkForDelete>
          <ftppasive>boolean</ftppasive>
          <FrequencyValue>string</FrequencyValue>
          <Frequency>string</Frequency>
          <LastRun>string</LastRun>
          <NextRun>string</NextRun>
          <MainLogoImage>string</MainLogoImage>
          <BottomLogoImage>string</BottomLogoImage>
          <BobbyBright>boolean</BobbyBright>
          <EnableImportManagerTemplateTable>boolean</EnableImportManagerTemplateTable>
          <LoginMessageOn>boolean</LoginMessageOn>
          <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
          <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
          <EnableFormLoginPage>boolean</EnableFormLoginPage>
          <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
          <LoginPageLayout>string</LoginPageLayout>
          <LoginPageForm>string</LoginPageForm>
          <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
          <EmailComponent>string</EmailComponent>
          <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
          <Suspended>boolean</Suspended>
          <LastSuspendedTime>dateTime</LastSuspendedTime>
        </Company>
      </GetCompanyResult>
    </GetCompanyResponse>
  </soap12:Body>
</soap12:Envelope>