BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

GetCustomer

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

<?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>
    <GetCustomer xmlns="http://tempuri.org/">
      <CustomerReference>string</CustomerReference>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetCustomer>
  </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>
    <GetCustomerResponse xmlns="http://tempuri.org/">
      <GetCustomerResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <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 xsi:nil="true" />
            <CustomerCaseDetails xsi:nil="true" />
          </CustomerCases>
          <HasChanges>boolean</HasChanges>
          <DataFolder>
            <DataFolderDetail xsi:nil="true" />
            <DataFolderDetail xsi:nil="true" />
          </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 xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <EmploymentStatusCode>string</EmploymentStatusCode>
          <PassportNumber>string</PassportNumber>
          <MultiContacts>
            <MultiContact xsi:nil="true" />
            <MultiContact xsi:nil="true" />
          </MultiContacts>
          <BankDetails>
            <CustomerBankDetails xsi:nil="true" />
            <CustomerBankDetails xsi:nil="true" />
          </BankDetails>
          <AdditionalApplicantDetails>
            <AdditionalApplicantDetails xsi:nil="true" />
            <AdditionalApplicantDetails xsi:nil="true" />
          </AdditionalApplicantDetails>
        </Customer>
      </GetCustomerResult>
    </GetCustomerResponse>
  </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>
    <GetCustomer xmlns="http://tempuri.org/">
      <CustomerReference>string</CustomerReference>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </GetCustomer>
  </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>
    <GetCustomerResponse xmlns="http://tempuri.org/">
      <GetCustomerResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <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 xsi:nil="true" />
            <CustomerCaseDetails xsi:nil="true" />
          </CustomerCases>
          <HasChanges>boolean</HasChanges>
          <DataFolder>
            <DataFolderDetail xsi:nil="true" />
            <DataFolderDetail xsi:nil="true" />
          </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 xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <EmploymentStatusCode>string</EmploymentStatusCode>
          <PassportNumber>string</PassportNumber>
          <MultiContacts>
            <MultiContact xsi:nil="true" />
            <MultiContact xsi:nil="true" />
          </MultiContacts>
          <BankDetails>
            <CustomerBankDetails xsi:nil="true" />
            <CustomerBankDetails xsi:nil="true" />
          </BankDetails>
          <AdditionalApplicantDetails>
            <AdditionalApplicantDetails xsi:nil="true" />
            <AdditionalApplicantDetails xsi:nil="true" />
          </AdditionalApplicantDetails>
        </Customer>
      </GetCustomerResult>
    </GetCustomerResponse>
  </soap12:Body>
</soap12:Envelope>