BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

CreateNewProspectWP

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

<?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>
    <CreateNewProspectWP xmlns="http://tempuri.org/">
      <customerWP>
        <CustomerReference>string</CustomerReference>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <CustomerAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </CustomerAddress>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <CustomerStatus>string</CustomerStatus>
        <CustomerTypes>
          <KVObjOfStringString>
            <Key>string</Key>
            <Value>string</Value>
          </KVObjOfStringString>
          <KVObjOfStringString>
            <Key>string</Key>
            <Value>string</Value>
          </KVObjOfStringString>
        </CustomerTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceAffiliate>string</SourceAffiliate>
        <B2BCustomer>boolean</B2BCustomer>
        <CustomerCases>
          <CustomerCaseDetails>
            <CaseRef>string</CaseRef>
            <CaseOwner>string</CaseOwner>
            <CaseBalance>decimal</CaseBalance>
          </CustomerCaseDetails>
          <CustomerCaseDetails>
            <CaseRef>string</CaseRef>
            <CaseOwner>string</CaseOwner>
            <CaseBalance>decimal</CaseBalance>
          </CustomerCaseDetails>
        </CustomerCases>
        <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>
        <LastUpdated>dateTime</LastUpdated>
        <StatusDate>dateTime</StatusDate>
        <RecordNumber>int</RecordNumber>
      </customerWP>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
    </CreateNewProspectWP>
  </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>
    <CreateNewProspectWPResponse xmlns="http://tempuri.org/">
      <CreateNewProspectWPResult>
        <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>
      </CreateNewProspectWPResult>
    </CreateNewProspectWPResponse>
  </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>
    <CreateNewProspectWP xmlns="http://tempuri.org/">
      <customerWP>
        <CustomerReference>string</CustomerReference>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <CustomerAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </CustomerAddress>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <CustomerStatus>string</CustomerStatus>
        <CustomerTypes>
          <KVObjOfStringString>
            <Key>string</Key>
            <Value>string</Value>
          </KVObjOfStringString>
          <KVObjOfStringString>
            <Key>string</Key>
            <Value>string</Value>
          </KVObjOfStringString>
        </CustomerTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceAffiliate>string</SourceAffiliate>
        <B2BCustomer>boolean</B2BCustomer>
        <CustomerCases>
          <CustomerCaseDetails>
            <CaseRef>string</CaseRef>
            <CaseOwner>string</CaseOwner>
            <CaseBalance>decimal</CaseBalance>
          </CustomerCaseDetails>
          <CustomerCaseDetails>
            <CaseRef>string</CaseRef>
            <CaseOwner>string</CaseOwner>
            <CaseBalance>decimal</CaseBalance>
          </CustomerCaseDetails>
        </CustomerCases>
        <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>
        <LastUpdated>dateTime</LastUpdated>
        <StatusDate>dateTime</StatusDate>
        <RecordNumber>int</RecordNumber>
      </customerWP>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
    </CreateNewProspectWP>
  </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>
    <CreateNewProspectWPResponse xmlns="http://tempuri.org/">
      <CreateNewProspectWPResult>
        <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>
      </CreateNewProspectWPResult>
    </CreateNewProspectWPResponse>
  </soap12:Body>
</soap12:Envelope>