BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

UpdateJobDataFolder

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

<?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>
    <UpdateJobDataFolder xmlns="http://tempuri.org/">
      <job>
        <JobReference>string</JobReference>
        <DateCreated>dateTime</DateCreated>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <MatterType>string</MatterType>
        <HomeTelephone>string</HomeTelephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <Salutation>string</Salutation>
        <Address>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </Address>
        <CustomerCode>string</CustomerCode>
        <MatterTypeDescription>string</MatterTypeDescription>
        <JobStatus>string</JobStatus>
        <JobStatusDescription>string</JobStatusDescription>
        <Engineer1Name>string</Engineer1Name>
        <Engineer1Label>string</Engineer1Label>
        <Engineer1JobStartDate>dateTime</Engineer1JobStartDate>
        <Engineer1JobEndDate>dateTime</Engineer1JobEndDate>
        <Engineer2Name>string</Engineer2Name>
        <Engineer2Label>string</Engineer2Label>
        <Engineer2JobStartDate>dateTime</Engineer2JobStartDate>
        <Engineer2JobEndDate>dateTime</Engineer2JobEndDate>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <HomeTelephone2>string</HomeTelephone2>
        <WorkTelephone2>string</WorkTelephone2>
        <Mobile2>string</Mobile2>
        <Email2>string</Email2>
        <CaseType>string</CaseType>
        <CustomerNames>string</CustomerNames>
        <CasesCustomerNames>string</CasesCustomerNames>
        <IsFilterByAppointmentsDateAndTime>boolean</IsFilterByAppointmentsDateAndTime>
        <AppointmentEndDate>dateTime</AppointmentEndDate>
        <Priority>string</Priority>
        <PriorityDescription>string</PriorityDescription>
        <HasChanges>boolean</HasChanges>
        <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 xsi:nil="true" />
            <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 xsi:nil="true" />
            <HasChanges>boolean</HasChanges>
          </DataFolderDetail>
        </DataFolder>
        <JobDetails>string</JobDetails>
        <InstallerNumber>string</InstallerNumber>
        <IsAllowUserReassignJobToThemselves>boolean</IsAllowUserReassignJobToThemselves>
        <EngineerType>string</EngineerType>
        <LoanAmount>double</LoanAmount>
        <Term>int</Term>
        <RepaymentType>string</RepaymentType>
        <TermType>string</TermType>
        <LoanType>string</LoanType>
        <TotalAmount>double</TotalAmount>
        <CaseOwner>string</CaseOwner>
        <CustomerOwner>string</CustomerOwner>
        <CaseUnderWriter>string</CaseUnderWriter>
        <CaseProcessor>string</CaseProcessor>
        <CaseAdditionalUser1>string</CaseAdditionalUser1>
        <CaseAdditionalUser2>string</CaseAdditionalUser2>
        <RebateCalculation>
          <EnableRebateCalculation>boolean</EnableRebateCalculation>
          <CurrentPeriodRebate>string</CurrentPeriodRebate>
          <NextPeriodRebate>string</NextPeriodRebate>
        </RebateCalculation>
        <CaseFinanciaData>
          <EnableRefinanceOption>boolean</EnableRefinanceOption>
          <CurrentBalance>double</CurrentBalance>
          <ArrearsBalance>double</ArrearsBalance>
          <ConsecutiveMissedPayments>int</ConsecutiveMissedPayments>
          <PeriodsInArrears>int</PeriodsInArrears>
        </CaseFinanciaData>
      </job>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateJobDataFolder>
  </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>
    <UpdateJobDataFolderResponse xmlns="http://tempuri.org/">
      <UpdateJobDataFolderResult>
        <UpdateResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </UpdateResult>
        <CustomerReference>string</CustomerReference>
        <CustomerName>string</CustomerName>
        <Title>string</Title>
        <OtherValue>
          <UpdateFieldValue>
            <FieldName>string</FieldName>
            <Value>string</Value>
          </UpdateFieldValue>
          <UpdateFieldValue>
            <FieldName>string</FieldName>
            <Value>string</Value>
          </UpdateFieldValue>
        </OtherValue>
      </UpdateJobDataFolderResult>
    </UpdateJobDataFolderResponse>
  </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>
    <UpdateJobDataFolder xmlns="http://tempuri.org/">
      <job>
        <JobReference>string</JobReference>
        <DateCreated>dateTime</DateCreated>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <MatterType>string</MatterType>
        <HomeTelephone>string</HomeTelephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <Salutation>string</Salutation>
        <Address>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </Address>
        <CustomerCode>string</CustomerCode>
        <MatterTypeDescription>string</MatterTypeDescription>
        <JobStatus>string</JobStatus>
        <JobStatusDescription>string</JobStatusDescription>
        <Engineer1Name>string</Engineer1Name>
        <Engineer1Label>string</Engineer1Label>
        <Engineer1JobStartDate>dateTime</Engineer1JobStartDate>
        <Engineer1JobEndDate>dateTime</Engineer1JobEndDate>
        <Engineer2Name>string</Engineer2Name>
        <Engineer2Label>string</Engineer2Label>
        <Engineer2JobStartDate>dateTime</Engineer2JobStartDate>
        <Engineer2JobEndDate>dateTime</Engineer2JobEndDate>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <HomeTelephone2>string</HomeTelephone2>
        <WorkTelephone2>string</WorkTelephone2>
        <Mobile2>string</Mobile2>
        <Email2>string</Email2>
        <CaseType>string</CaseType>
        <CustomerNames>string</CustomerNames>
        <CasesCustomerNames>string</CasesCustomerNames>
        <IsFilterByAppointmentsDateAndTime>boolean</IsFilterByAppointmentsDateAndTime>
        <AppointmentEndDate>dateTime</AppointmentEndDate>
        <Priority>string</Priority>
        <PriorityDescription>string</PriorityDescription>
        <HasChanges>boolean</HasChanges>
        <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 xsi:nil="true" />
            <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 xsi:nil="true" />
            <HasChanges>boolean</HasChanges>
          </DataFolderDetail>
        </DataFolder>
        <JobDetails>string</JobDetails>
        <InstallerNumber>string</InstallerNumber>
        <IsAllowUserReassignJobToThemselves>boolean</IsAllowUserReassignJobToThemselves>
        <EngineerType>string</EngineerType>
        <LoanAmount>double</LoanAmount>
        <Term>int</Term>
        <RepaymentType>string</RepaymentType>
        <TermType>string</TermType>
        <LoanType>string</LoanType>
        <TotalAmount>double</TotalAmount>
        <CaseOwner>string</CaseOwner>
        <CustomerOwner>string</CustomerOwner>
        <CaseUnderWriter>string</CaseUnderWriter>
        <CaseProcessor>string</CaseProcessor>
        <CaseAdditionalUser1>string</CaseAdditionalUser1>
        <CaseAdditionalUser2>string</CaseAdditionalUser2>
        <RebateCalculation>
          <EnableRebateCalculation>boolean</EnableRebateCalculation>
          <CurrentPeriodRebate>string</CurrentPeriodRebate>
          <NextPeriodRebate>string</NextPeriodRebate>
        </RebateCalculation>
        <CaseFinanciaData>
          <EnableRefinanceOption>boolean</EnableRefinanceOption>
          <CurrentBalance>double</CurrentBalance>
          <ArrearsBalance>double</ArrearsBalance>
          <ConsecutiveMissedPayments>int</ConsecutiveMissedPayments>
          <PeriodsInArrears>int</PeriodsInArrears>
        </CaseFinanciaData>
      </job>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </UpdateJobDataFolder>
  </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>
    <UpdateJobDataFolderResponse xmlns="http://tempuri.org/">
      <UpdateJobDataFolderResult>
        <UpdateResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </UpdateResult>
        <CustomerReference>string</CustomerReference>
        <CustomerName>string</CustomerName>
        <Title>string</Title>
        <OtherValue>
          <UpdateFieldValue>
            <FieldName>string</FieldName>
            <Value>string</Value>
          </UpdateFieldValue>
          <UpdateFieldValue>
            <FieldName>string</FieldName>
            <Value>string</Value>
          </UpdateFieldValue>
        </OtherValue>
      </UpdateJobDataFolderResult>
    </UpdateJobDataFolderResponse>
  </soap12:Body>
</soap12:Envelope>