BrightofficeAPI

Click here for a complete list of operations.

UpdateDataFolderList

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

<?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>
    <UpdateDataFolderList xmlns="http://tempuri.org/">
      <dataFolder>
        <DataFolderDetail>
          <Id>int</Id>
          <Description>string</Description>
          <Notes>string</Notes>
          <DateReceived>dateTime</DateReceived>
          <DateReturned>dateTime</DateReturned>
          <IncludeInXMLSend>boolean</IncludeInXMLSend>
          <JobCode>string</JobCode>
          <Code>string</Code>
          <CustomerCode>string</CustomerCode>
          <ApplicantId>string</ApplicantId>
          <DelegateCode>string</DelegateCode>
          <CaseItemsOnFiles>
            <CaseItemsOnFile xsi:nil="true" />
            <CaseItemsOnFile xsi:nil="true" />
          </CaseItemsOnFiles>
          <HasChanges>boolean</HasChanges>
        </DataFolderDetail>
        <DataFolderDetail>
          <Id>int</Id>
          <Description>string</Description>
          <Notes>string</Notes>
          <DateReceived>dateTime</DateReceived>
          <DateReturned>dateTime</DateReturned>
          <IncludeInXMLSend>boolean</IncludeInXMLSend>
          <JobCode>string</JobCode>
          <Code>string</Code>
          <CustomerCode>string</CustomerCode>
          <ApplicantId>string</ApplicantId>
          <DelegateCode>string</DelegateCode>
          <CaseItemsOnFiles>
            <CaseItemsOnFile xsi:nil="true" />
            <CaseItemsOnFile xsi:nil="true" />
          </CaseItemsOnFiles>
          <HasChanges>boolean</HasChanges>
        </DataFolderDetail>
      </dataFolder>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateDataFolderList>
  </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>
    <UpdateDataFolderListResponse xmlns="http://tempuri.org/">
      <UpdateDataFolderListResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </UpdateDataFolderListResult>
    </UpdateDataFolderListResponse>
  </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>
    <UpdateDataFolderList xmlns="http://tempuri.org/">
      <dataFolder>
        <DataFolderDetail>
          <Id>int</Id>
          <Description>string</Description>
          <Notes>string</Notes>
          <DateReceived>dateTime</DateReceived>
          <DateReturned>dateTime</DateReturned>
          <IncludeInXMLSend>boolean</IncludeInXMLSend>
          <JobCode>string</JobCode>
          <Code>string</Code>
          <CustomerCode>string</CustomerCode>
          <ApplicantId>string</ApplicantId>
          <DelegateCode>string</DelegateCode>
          <CaseItemsOnFiles>
            <CaseItemsOnFile xsi:nil="true" />
            <CaseItemsOnFile xsi:nil="true" />
          </CaseItemsOnFiles>
          <HasChanges>boolean</HasChanges>
        </DataFolderDetail>
        <DataFolderDetail>
          <Id>int</Id>
          <Description>string</Description>
          <Notes>string</Notes>
          <DateReceived>dateTime</DateReceived>
          <DateReturned>dateTime</DateReturned>
          <IncludeInXMLSend>boolean</IncludeInXMLSend>
          <JobCode>string</JobCode>
          <Code>string</Code>
          <CustomerCode>string</CustomerCode>
          <ApplicantId>string</ApplicantId>
          <DelegateCode>string</DelegateCode>
          <CaseItemsOnFiles>
            <CaseItemsOnFile xsi:nil="true" />
            <CaseItemsOnFile xsi:nil="true" />
          </CaseItemsOnFiles>
          <HasChanges>boolean</HasChanges>
        </DataFolderDetail>
      </dataFolder>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateDataFolderList>
  </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>
    <UpdateDataFolderListResponse xmlns="http://tempuri.org/">
      <UpdateDataFolderListResult>
        <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <IsSystemError>boolean</IsSystemError>
      </UpdateDataFolderListResult>
    </UpdateDataFolderListResponse>
  </soap12:Body>
</soap12:Envelope>