BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

CreateNewProspectV2

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

<?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>
    <CreateNewProspectV2 xmlns="http://tempuri.org/">
      <customer>
        <CustomerReference>string</CustomerReference>
        <AvoidUpdatingBlankData>boolean</AvoidUpdatingBlankData>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <AltSalutation>string</AltSalutation>
        <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>
        <CompanyAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </CompanyAddress>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <SupervisorConfirmer>string</SupervisorConfirmer>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <CustomerStatus>string</CustomerStatus>
        <CustomerTypes>
          <anyType />
          <anyType />
        </CustomerTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceName>string</SourceName>
        <SourceAffiliate>string</SourceAffiliate>
        <SourceAffiliateName>string</SourceAffiliateName>
        <SourceType>string</SourceType>
        <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>
        <AllowUsersToCreateAppointment>boolean</AllowUsersToCreateAppointment>
        <CompanyName>string</CompanyName>
        <OwnerCode>string</OwnerCode>
        <AlternateSalutation>string</AlternateSalutation>
        <OwnerName>string</OwnerName>
        <InvoiceTermName>string</InvoiceTermName>
        <ContactMethod>
          <string>string</string>
          <string>string</string>
        </ContactMethod>
        <SmartphoneDeviceType>string</SmartphoneDeviceType>
        <SmartphoneDeviceToken>string</SmartphoneDeviceToken>
        <IsDeduplicationReq>boolean</IsDeduplicationReq>
        <IsUpdateCaseCustomer>boolean</IsUpdateCaseCustomer>
        <PointsAvailable>int</PointsAvailable>
        <CreditSafeConnectId>string</CreditSafeConnectId>
        <CreditSafePeopleId>string</CreditSafePeopleId>
        <CountryCode>string</CountryCode>
        <Currency>string</Currency>
        <CustomerGroup>string</CustomerGroup>
        <Region>string</Region>
        <CustomFields>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomFields>
        <EmploymentStatusCode>string</EmploymentStatusCode>
        <PassportNumber>string</PassportNumber>
        <MultiContacts>
          <MultiContact>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <DirectPhone>string</DirectPhone>
            <Email>string</Email>
            <Position>string</Position>
            <Mobile>string</Mobile>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <Guarantor>boolean</Guarantor>
            <DateOfBirth>dateTime</DateOfBirth>
            <IncludeInPIP>boolean</IncludeInPIP>
            <CustomFields xsi:nil="true" />
            <ForceDelete>boolean</ForceDelete>
          </MultiContact>
          <MultiContact>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <DirectPhone>string</DirectPhone>
            <Email>string</Email>
            <Position>string</Position>
            <Mobile>string</Mobile>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <Guarantor>boolean</Guarantor>
            <DateOfBirth>dateTime</DateOfBirth>
            <IncludeInPIP>boolean</IncludeInPIP>
            <CustomFields xsi:nil="true" />
            <ForceDelete>boolean</ForceDelete>
          </MultiContact>
        </MultiContacts>
        <BankDetails>
          <CustomerBankDetails>
            <BankName>string</BankName>
            <AccountName>string</AccountName>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
          </CustomerBankDetails>
          <CustomerBankDetails>
            <BankName>string</BankName>
            <AccountName>string</AccountName>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
          </CustomerBankDetails>
        </BankDetails>
        <AdditionalApplicantDetails>
          <AdditionalApplicantDetails>
            <ApplicantNumber>int</ApplicantNumber>
            <Title>string</Title>
            <Name>string</Name>
            <Surname>string</Surname>
            <Telephone>string</Telephone>
            <TelephoneWork>string</TelephoneWork>
            <Mobile>string</Mobile>
            <DateOfBirth>string</DateOfBirth>
            <Sex>string</Sex>
            <Email>string</Email>
            <SicCode>string</SicCode>
            <Nationality>string</Nationality>
            <PreviousName>string</PreviousName>
            <Ethnicity>string</Ethnicity>
            <CreditSafePeopleId>string</CreditSafePeopleId>
            <Address xsi:nil="true" />
          </AdditionalApplicantDetails>
          <AdditionalApplicantDetails>
            <ApplicantNumber>int</ApplicantNumber>
            <Title>string</Title>
            <Name>string</Name>
            <Surname>string</Surname>
            <Telephone>string</Telephone>
            <TelephoneWork>string</TelephoneWork>
            <Mobile>string</Mobile>
            <DateOfBirth>string</DateOfBirth>
            <Sex>string</Sex>
            <Email>string</Email>
            <SicCode>string</SicCode>
            <Nationality>string</Nationality>
            <PreviousName>string</PreviousName>
            <Ethnicity>string</Ethnicity>
            <CreditSafePeopleId>string</CreditSafePeopleId>
            <Address xsi:nil="true" />
          </AdditionalApplicantDetails>
        </AdditionalApplicantDetails>
      </customer>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
      <ClientPassword>string</ClientPassword>
    </CreateNewProspectV2>
  </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>
    <CreateNewProspectV2Response xmlns="http://tempuri.org/">
      <CreateNewProspectV2Result>
        <CustomerCreditLimit>double</CustomerCreditLimit>
      </CreateNewProspectV2Result>
    </CreateNewProspectV2Response>
  </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>
    <CreateNewProspectV2 xmlns="http://tempuri.org/">
      <customer>
        <CustomerReference>string</CustomerReference>
        <AvoidUpdatingBlankData>boolean</AvoidUpdatingBlankData>
        <Title1>string</Title1>
        <Firstname>string</Firstname>
        <Surname>string</Surname>
        <Title2>string</Title2>
        <Firstname2>string</Firstname2>
        <Surname2>string</Surname2>
        <AltSalutation>string</AltSalutation>
        <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>
        <CompanyAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </CompanyAddress>
        <DateCreated>dateTime</DateCreated>
        <OldReference>string</OldReference>
        <Telephone>string</Telephone>
        <WorkTelephone>string</WorkTelephone>
        <Mobile>string</Mobile>
        <Fax>string</Fax>
        <Email>string</Email>
        <Website>string</Website>
        <SupervisorConfirmer>string</SupervisorConfirmer>
        <DateOfBirth>dateTime</DateOfBirth>
        <NationalInsuranceNumber>string</NationalInsuranceNumber>
        <CustomerStatus>string</CustomerStatus>
        <CustomerTypes>
          <anyType />
          <anyType />
        </CustomerTypes>
        <Notes>string</Notes>
        <Source>string</Source>
        <SourceName>string</SourceName>
        <SourceAffiliate>string</SourceAffiliate>
        <SourceAffiliateName>string</SourceAffiliateName>
        <SourceType>string</SourceType>
        <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>
        <AllowUsersToCreateAppointment>boolean</AllowUsersToCreateAppointment>
        <CompanyName>string</CompanyName>
        <OwnerCode>string</OwnerCode>
        <AlternateSalutation>string</AlternateSalutation>
        <OwnerName>string</OwnerName>
        <InvoiceTermName>string</InvoiceTermName>
        <ContactMethod>
          <string>string</string>
          <string>string</string>
        </ContactMethod>
        <SmartphoneDeviceType>string</SmartphoneDeviceType>
        <SmartphoneDeviceToken>string</SmartphoneDeviceToken>
        <IsDeduplicationReq>boolean</IsDeduplicationReq>
        <IsUpdateCaseCustomer>boolean</IsUpdateCaseCustomer>
        <PointsAvailable>int</PointsAvailable>
        <CreditSafeConnectId>string</CreditSafeConnectId>
        <CreditSafePeopleId>string</CreditSafePeopleId>
        <CountryCode>string</CountryCode>
        <Currency>string</Currency>
        <CustomerGroup>string</CustomerGroup>
        <Region>string</Region>
        <CustomFields>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomFields>
        <EmploymentStatusCode>string</EmploymentStatusCode>
        <PassportNumber>string</PassportNumber>
        <MultiContacts>
          <MultiContact>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <DirectPhone>string</DirectPhone>
            <Email>string</Email>
            <Position>string</Position>
            <Mobile>string</Mobile>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <Guarantor>boolean</Guarantor>
            <DateOfBirth>dateTime</DateOfBirth>
            <IncludeInPIP>boolean</IncludeInPIP>
            <CustomFields xsi:nil="true" />
            <ForceDelete>boolean</ForceDelete>
          </MultiContact>
          <MultiContact>
            <Firstname>string</Firstname>
            <Surname>string</Surname>
            <DirectPhone>string</DirectPhone>
            <Email>string</Email>
            <Position>string</Position>
            <Mobile>string</Mobile>
            <Address1>string</Address1>
            <Address2>string</Address2>
            <Address3>string</Address3>
            <Address4>string</Address4>
            <PostCode>string</PostCode>
            <Guarantor>boolean</Guarantor>
            <DateOfBirth>dateTime</DateOfBirth>
            <IncludeInPIP>boolean</IncludeInPIP>
            <CustomFields xsi:nil="true" />
            <ForceDelete>boolean</ForceDelete>
          </MultiContact>
        </MultiContacts>
        <BankDetails>
          <CustomerBankDetails>
            <BankName>string</BankName>
            <AccountName>string</AccountName>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
          </CustomerBankDetails>
          <CustomerBankDetails>
            <BankName>string</BankName>
            <AccountName>string</AccountName>
            <AccountNumber>string</AccountNumber>
            <SortCode>string</SortCode>
          </CustomerBankDetails>
        </BankDetails>
        <AdditionalApplicantDetails>
          <AdditionalApplicantDetails>
            <ApplicantNumber>int</ApplicantNumber>
            <Title>string</Title>
            <Name>string</Name>
            <Surname>string</Surname>
            <Telephone>string</Telephone>
            <TelephoneWork>string</TelephoneWork>
            <Mobile>string</Mobile>
            <DateOfBirth>string</DateOfBirth>
            <Sex>string</Sex>
            <Email>string</Email>
            <SicCode>string</SicCode>
            <Nationality>string</Nationality>
            <PreviousName>string</PreviousName>
            <Ethnicity>string</Ethnicity>
            <CreditSafePeopleId>string</CreditSafePeopleId>
            <Address xsi:nil="true" />
          </AdditionalApplicantDetails>
          <AdditionalApplicantDetails>
            <ApplicantNumber>int</ApplicantNumber>
            <Title>string</Title>
            <Name>string</Name>
            <Surname>string</Surname>
            <Telephone>string</Telephone>
            <TelephoneWork>string</TelephoneWork>
            <Mobile>string</Mobile>
            <DateOfBirth>string</DateOfBirth>
            <Sex>string</Sex>
            <Email>string</Email>
            <SicCode>string</SicCode>
            <Nationality>string</Nationality>
            <PreviousName>string</PreviousName>
            <Ethnicity>string</Ethnicity>
            <CreditSafePeopleId>string</CreditSafePeopleId>
            <Address xsi:nil="true" />
          </AdditionalApplicantDetails>
        </AdditionalApplicantDetails>
      </customer>
      <userInfo>
        <Username>string</Username>
        <Password>string</Password>
      </userInfo>
      <ClientPassword>string</ClientPassword>
    </CreateNewProspectV2>
  </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>
    <CreateNewProspectV2Response xmlns="http://tempuri.org/">
      <CreateNewProspectV2Result>
        <CustomerCreditLimit>double</CustomerCreditLimit>
      </CreateNewProspectV2Result>
    </CreateNewProspectV2Response>
  </soap12:Body>
</soap12:Envelope>