BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

UpdateCompany

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

<?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>
    <UpdateCompany xmlns="http://tempuri.org/">
      <updatedCompanyDetails>
        <CompanyID>int</CompanyID>
        <ActiveCompany>boolean</ActiveCompany>
        <NASStorage>boolean</NASStorage>
        <CompanyURL>string</CompanyURL>
        <CompanyName>string</CompanyName>
        <BrowserTitle>string</BrowserTitle>
        <WelcomeText>string</WelcomeText>
        <CSSFile>string</CSSFile>
        <OverrideSQLSALogin>string</OverrideSQLSALogin>
        <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
        <UserReportLocation>string</UserReportLocation>
        <BrightOfficeInternal>boolean</BrightOfficeInternal>
        <ActiveBackup>boolean</ActiveBackup>
        <Edraw>string</Edraw>
        <Aspose>string</Aspose>
        <UAReference>string</UAReference>
        <WordLocation>string</WordLocation>
        <ExcelLocation>string</ExcelLocation>
        <PersonalLocation>string</PersonalLocation>
        <ImagesLocation>string</ImagesLocation>
        <CorrespondanceLocation>string</CorrespondanceLocation>
        <Twain>string</Twain>
        <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
        <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
        <BrightOffice>string</BrightOffice>
        <DisableWritingtoErrorLog>boolean</DisableWritingtoErrorLog>
        <ftphost>string</ftphost>
        <ftpuser>string</ftpuser>
        <ftppass>string</ftppass>
        <ftppath>string</ftppath>
        <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
        <SecureFtpTransfer>boolean</SecureFtpTransfer>
        <MarkForDelete>boolean</MarkForDelete>
        <ftppasive>boolean</ftppasive>
        <FrequencyValue>string</FrequencyValue>
        <Frequency>string</Frequency>
        <MainLogoImage>string</MainLogoImage>
        <BottomLogoImage>string</BottomLogoImage>
        <BobbyBright>boolean</BobbyBright>
        <LoginMessageOn>boolean</LoginMessageOn>
        <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
        <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
        <EnableFormLoginPage>boolean</EnableFormLoginPage>
        <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
        <LoginPageLayout>string</LoginPageLayout>
        <LoginPageForm>string</LoginPageForm>
        <InfrastructurePlatform>string</InfrastructurePlatform>
        <InfrastructurePlatformServerIP>string</InfrastructurePlatformServerIP>
        <InfrastructurePlatformUsername>string</InfrastructurePlatformUsername>
        <InfrastructurePlatformPassword>string</InfrastructurePlatformPassword>
        <InfrastructurePlatformURL>string</InfrastructurePlatformURL>
        <InfrastructurePlatformAPIKey>string</InfrastructurePlatformAPIKey>
        <EmailComponent>string</EmailComponent>
        <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
        <ASPNet>string</ASPNet>
        <EmailVerifierMultiThreaded>boolean</EmailVerifierMultiThreaded>
        <ExcelReaderVersion>string</ExcelReaderVersion>
        <BusinessMode>string</BusinessMode>
        <ProductDocumentsPath>string</ProductDocumentsPath>
        <HealthSafetyPath>string</HealthSafetyPath>
        <GeneralDocumentsPath>string</GeneralDocumentsPath>
        <DocumentEditorWebserviceURL>string</DocumentEditorWebserviceURL>
        <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
        <Suspended>boolean</Suspended>
        <LastSuspendedTime>dateTime</LastSuspendedTime>
      </updatedCompanyDetails>
      <hashCode>string</hashCode>
      <IsOnlyUpdateFTPBackup>boolean</IsOnlyUpdateFTPBackup>
    </UpdateCompany>
  </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>
    <UpdateCompanyResponse xmlns="http://tempuri.org/">
      <UpdateCompanyResult>
        <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>
          <ActiveCompany>boolean</ActiveCompany>
          <NASStorage>boolean</NASStorage>
          <CompanyURL>string</CompanyURL>
          <CompanyName>string</CompanyName>
          <BrowserTitle>string</BrowserTitle>
          <WelcomeText>string</WelcomeText>
          <CSSFile>string</CSSFile>
          <OverrideSQLSALogin>string</OverrideSQLSALogin>
          <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
          <UserReportLocation>string</UserReportLocation>
          <BrightOfficeInternal>boolean</BrightOfficeInternal>
          <ActiveBackup>boolean</ActiveBackup>
          <Edraw>string</Edraw>
          <Aspose>string</Aspose>
          <UAReference>string</UAReference>
          <WordLocation>string</WordLocation>
          <ExcelLocation>string</ExcelLocation>
          <PersonalLocation>string</PersonalLocation>
          <ImagesLocation>string</ImagesLocation>
          <CorrespondanceLocation>string</CorrespondanceLocation>
          <Twain>string</Twain>
          <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
          <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
          <BrightOffice>string</BrightOffice>
          <DisableWritingtoErrorLog>boolean</DisableWritingtoErrorLog>
          <ftphost>string</ftphost>
          <ftpuser>string</ftpuser>
          <ftppass>string</ftppass>
          <ftppath>string</ftppath>
          <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
          <SecureFtpTransfer>boolean</SecureFtpTransfer>
          <MarkForDelete>boolean</MarkForDelete>
          <ftppasive>boolean</ftppasive>
          <FrequencyValue>string</FrequencyValue>
          <Frequency>string</Frequency>
          <MainLogoImage>string</MainLogoImage>
          <BottomLogoImage>string</BottomLogoImage>
          <BobbyBright>boolean</BobbyBright>
          <LoginMessageOn>boolean</LoginMessageOn>
          <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
          <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
          <EnableFormLoginPage>boolean</EnableFormLoginPage>
          <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
          <LoginPageLayout>string</LoginPageLayout>
          <LoginPageForm>string</LoginPageForm>
          <InfrastructurePlatform>string</InfrastructurePlatform>
          <InfrastructurePlatformServerIP>string</InfrastructurePlatformServerIP>
          <InfrastructurePlatformUsername>string</InfrastructurePlatformUsername>
          <InfrastructurePlatformPassword>string</InfrastructurePlatformPassword>
          <InfrastructurePlatformURL>string</InfrastructurePlatformURL>
          <InfrastructurePlatformAPIKey>string</InfrastructurePlatformAPIKey>
          <EmailComponent>string</EmailComponent>
          <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
          <ASPNet>string</ASPNet>
          <EmailVerifierMultiThreaded>boolean</EmailVerifierMultiThreaded>
          <ExcelReaderVersion>string</ExcelReaderVersion>
          <BusinessMode>string</BusinessMode>
          <ProductDocumentsPath>string</ProductDocumentsPath>
          <HealthSafetyPath>string</HealthSafetyPath>
          <GeneralDocumentsPath>string</GeneralDocumentsPath>
          <DocumentEditorWebserviceURL>string</DocumentEditorWebserviceURL>
          <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
          <Suspended>boolean</Suspended>
          <LastSuspendedTime>dateTime</LastSuspendedTime>
        </Company>
      </UpdateCompanyResult>
    </UpdateCompanyResponse>
  </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>
    <UpdateCompany xmlns="http://tempuri.org/">
      <updatedCompanyDetails>
        <CompanyID>int</CompanyID>
        <ActiveCompany>boolean</ActiveCompany>
        <NASStorage>boolean</NASStorage>
        <CompanyURL>string</CompanyURL>
        <CompanyName>string</CompanyName>
        <BrowserTitle>string</BrowserTitle>
        <WelcomeText>string</WelcomeText>
        <CSSFile>string</CSSFile>
        <OverrideSQLSALogin>string</OverrideSQLSALogin>
        <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
        <UserReportLocation>string</UserReportLocation>
        <BrightOfficeInternal>boolean</BrightOfficeInternal>
        <ActiveBackup>boolean</ActiveBackup>
        <Edraw>string</Edraw>
        <Aspose>string</Aspose>
        <UAReference>string</UAReference>
        <WordLocation>string</WordLocation>
        <ExcelLocation>string</ExcelLocation>
        <PersonalLocation>string</PersonalLocation>
        <ImagesLocation>string</ImagesLocation>
        <CorrespondanceLocation>string</CorrespondanceLocation>
        <Twain>string</Twain>
        <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
        <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
        <BrightOffice>string</BrightOffice>
        <DisableWritingtoErrorLog>boolean</DisableWritingtoErrorLog>
        <ftphost>string</ftphost>
        <ftpuser>string</ftpuser>
        <ftppass>string</ftppass>
        <ftppath>string</ftppath>
        <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
        <SecureFtpTransfer>boolean</SecureFtpTransfer>
        <MarkForDelete>boolean</MarkForDelete>
        <ftppasive>boolean</ftppasive>
        <FrequencyValue>string</FrequencyValue>
        <Frequency>string</Frequency>
        <MainLogoImage>string</MainLogoImage>
        <BottomLogoImage>string</BottomLogoImage>
        <BobbyBright>boolean</BobbyBright>
        <LoginMessageOn>boolean</LoginMessageOn>
        <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
        <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
        <EnableFormLoginPage>boolean</EnableFormLoginPage>
        <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
        <LoginPageLayout>string</LoginPageLayout>
        <LoginPageForm>string</LoginPageForm>
        <InfrastructurePlatform>string</InfrastructurePlatform>
        <InfrastructurePlatformServerIP>string</InfrastructurePlatformServerIP>
        <InfrastructurePlatformUsername>string</InfrastructurePlatformUsername>
        <InfrastructurePlatformPassword>string</InfrastructurePlatformPassword>
        <InfrastructurePlatformURL>string</InfrastructurePlatformURL>
        <InfrastructurePlatformAPIKey>string</InfrastructurePlatformAPIKey>
        <EmailComponent>string</EmailComponent>
        <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
        <ASPNet>string</ASPNet>
        <EmailVerifierMultiThreaded>boolean</EmailVerifierMultiThreaded>
        <ExcelReaderVersion>string</ExcelReaderVersion>
        <BusinessMode>string</BusinessMode>
        <ProductDocumentsPath>string</ProductDocumentsPath>
        <HealthSafetyPath>string</HealthSafetyPath>
        <GeneralDocumentsPath>string</GeneralDocumentsPath>
        <DocumentEditorWebserviceURL>string</DocumentEditorWebserviceURL>
        <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
        <Suspended>boolean</Suspended>
        <LastSuspendedTime>dateTime</LastSuspendedTime>
      </updatedCompanyDetails>
      <hashCode>string</hashCode>
      <IsOnlyUpdateFTPBackup>boolean</IsOnlyUpdateFTPBackup>
    </UpdateCompany>
  </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>
    <UpdateCompanyResponse xmlns="http://tempuri.org/">
      <UpdateCompanyResult>
        <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>
          <ActiveCompany>boolean</ActiveCompany>
          <NASStorage>boolean</NASStorage>
          <CompanyURL>string</CompanyURL>
          <CompanyName>string</CompanyName>
          <BrowserTitle>string</BrowserTitle>
          <WelcomeText>string</WelcomeText>
          <CSSFile>string</CSSFile>
          <OverrideSQLSALogin>string</OverrideSQLSALogin>
          <ReportManagerGeneratedReportCountTreshold>string</ReportManagerGeneratedReportCountTreshold>
          <UserReportLocation>string</UserReportLocation>
          <BrightOfficeInternal>boolean</BrightOfficeInternal>
          <ActiveBackup>boolean</ActiveBackup>
          <Edraw>string</Edraw>
          <Aspose>string</Aspose>
          <UAReference>string</UAReference>
          <WordLocation>string</WordLocation>
          <ExcelLocation>string</ExcelLocation>
          <PersonalLocation>string</PersonalLocation>
          <ImagesLocation>string</ImagesLocation>
          <CorrespondanceLocation>string</CorrespondanceLocation>
          <Twain>string</Twain>
          <EnableExchangePerMessage>boolean</EnableExchangePerMessage>
          <WebMailSearchFromPeek>boolean</WebMailSearchFromPeek>
          <BrightOffice>string</BrightOffice>
          <DisableWritingtoErrorLog>boolean</DisableWritingtoErrorLog>
          <ftphost>string</ftphost>
          <ftpuser>string</ftpuser>
          <ftppass>string</ftppass>
          <ftppath>string</ftppath>
          <ActiveFtpTransfer>boolean</ActiveFtpTransfer>
          <SecureFtpTransfer>boolean</SecureFtpTransfer>
          <MarkForDelete>boolean</MarkForDelete>
          <ftppasive>boolean</ftppasive>
          <FrequencyValue>string</FrequencyValue>
          <Frequency>string</Frequency>
          <MainLogoImage>string</MainLogoImage>
          <BottomLogoImage>string</BottomLogoImage>
          <BobbyBright>boolean</BobbyBright>
          <LoginMessageOn>boolean</LoginMessageOn>
          <DisableStarIconAndSalesHelp>boolean</DisableStarIconAndSalesHelp>
          <DisableRememberUsernameAndPassword>boolean</DisableRememberUsernameAndPassword>
          <EnableFormLoginPage>boolean</EnableFormLoginPage>
          <DisableRemoteSupportProvider>boolean</DisableRemoteSupportProvider>
          <LoginPageLayout>string</LoginPageLayout>
          <LoginPageForm>string</LoginPageForm>
          <InfrastructurePlatform>string</InfrastructurePlatform>
          <InfrastructurePlatformServerIP>string</InfrastructurePlatformServerIP>
          <InfrastructurePlatformUsername>string</InfrastructurePlatformUsername>
          <InfrastructurePlatformPassword>string</InfrastructurePlatformPassword>
          <InfrastructurePlatformURL>string</InfrastructurePlatformURL>
          <InfrastructurePlatformAPIKey>string</InfrastructurePlatformAPIKey>
          <EmailComponent>string</EmailComponent>
          <EmailComponentSslProtocol>string</EmailComponentSslProtocol>
          <ASPNet>string</ASPNet>
          <EmailVerifierMultiThreaded>boolean</EmailVerifierMultiThreaded>
          <ExcelReaderVersion>string</ExcelReaderVersion>
          <BusinessMode>string</BusinessMode>
          <ProductDocumentsPath>string</ProductDocumentsPath>
          <HealthSafetyPath>string</HealthSafetyPath>
          <GeneralDocumentsPath>string</GeneralDocumentsPath>
          <DocumentEditorWebserviceURL>string</DocumentEditorWebserviceURL>
          <EnableHiddenPasswords>boolean</EnableHiddenPasswords>
          <Suspended>boolean</Suspended>
          <LastSuspendedTime>dateTime</LastSuspendedTime>
        </Company>
      </UpdateCompanyResult>
    </UpdateCompanyResponse>
  </soap12:Body>
</soap12:Envelope>