BrightofficeAPI

Click here for a complete list of operations.

CreateSource

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

<?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>
    <CreateSource xmlns="http://tempuri.org/">
      <pRequest>
        <SourceCode>string</SourceCode>
        <SourceName>string</SourceName>
        <SourceStatus>string</SourceStatus>
        <SourceStatusDesc>string</SourceStatusDesc>
        <Contact>string</Contact>
        <Salutation>string</Salutation>
        <WebSite>string</WebSite>
        <Telephone>string</Telephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <Fax>string</Fax>
        <Notes>string</Notes>
        <SourceCategory>string</SourceCategory>
        <SourceCategoryDesc>string</SourceCategoryDesc>
        <SourceArea>string</SourceArea>
        <SourceAreaDesc>string</SourceAreaDesc>
        <SourceRegion>string</SourceRegion>
        <SourceRegionDesc>string</SourceRegionDesc>
        <SourceReference>string</SourceReference>
        <SourceBrokerNetworks>
          <BrokerNetwork>
            <BrokerNetworkCompanyName>string</BrokerNetworkCompanyName>
          </BrokerNetwork>
          <BrokerNetwork>
            <BrokerNetworkCompanyName>string</BrokerNetworkCompanyName>
          </BrokerNetwork>
        </SourceBrokerNetworks>
        <DistanceFromCurrent>double</DistanceFromCurrent>
        <SourceAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </SourceAddress>
        <SourceCaseDetail>
          <TotalCases>int</TotalCases>
          <TotalCompletedCases>int</TotalCompletedCases>
          <TotalCancelledCases>int</TotalCancelledCases>
          <TotalInProgressCases>int</TotalInProgressCases>
          <TotalLoan>double</TotalLoan>
        </SourceCaseDetail>
        <SourceTypes>
          <SourceType>
            <SourceType>string</SourceType>
          </SourceType>
          <SourceType>
            <SourceType>string</SourceType>
          </SourceType>
        </SourceTypes>
        <SourceRep>int</SourceRep>
        <SourceLead>int</SourceLead>
        <SourceStatementText>string</SourceStatementText>
        <SourceCreatedDate>string</SourceCreatedDate>
        <Additional1User>string</Additional1User>
        <Additional1UserName>string</Additional1UserName>
        <Additional2User>string</Additional2User>
        <Additional2UserName>string</Additional2UserName>
        <SourceAffiliates>
          <SourceAffiliateResult>
            <SourceAffiliateCode>string</SourceAffiliateCode>
            <SourceAffiliateName>string</SourceAffiliateName>
            <SourceAffiliateAddress xsi:nil="true" />
            <Contact>string</Contact>
            <WebSite>string</WebSite>
            <Telephone>string</Telephone>
            <Fax>string</Fax>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <Salutation>string</Salutation>
            <SourceAffiliateStatus>string</SourceAffiliateStatus>
            <SourceAffiliateStatusDesc>string</SourceAffiliateStatusDesc>
            <SourceAffiliateType>string</SourceAffiliateType>
            <SourceAffiliateTypeDesc>string</SourceAffiliateTypeDesc>
            <SourceAffiliateRegion>string</SourceAffiliateRegion>
            <SourceAffiliateRegionDesc>string</SourceAffiliateRegionDesc>
          </SourceAffiliateResult>
          <SourceAffiliateResult>
            <SourceAffiliateCode>string</SourceAffiliateCode>
            <SourceAffiliateName>string</SourceAffiliateName>
            <SourceAffiliateAddress xsi:nil="true" />
            <Contact>string</Contact>
            <WebSite>string</WebSite>
            <Telephone>string</Telephone>
            <Fax>string</Fax>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <Salutation>string</Salutation>
            <SourceAffiliateStatus>string</SourceAffiliateStatus>
            <SourceAffiliateStatusDesc>string</SourceAffiliateStatusDesc>
            <SourceAffiliateType>string</SourceAffiliateType>
            <SourceAffiliateTypeDesc>string</SourceAffiliateTypeDesc>
            <SourceAffiliateRegion>string</SourceAffiliateRegion>
            <SourceAffiliateRegionDesc>string</SourceAffiliateRegionDesc>
          </SourceAffiliateResult>
        </SourceAffiliates>
        <EnableCommission>boolean</EnableCommission>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateSource>
  </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>
    <CreateSourceResponse xmlns="http://tempuri.org/">
      <CreateSourceResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateSourceResult>
    </CreateSourceResponse>
  </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>
    <CreateSource xmlns="http://tempuri.org/">
      <pRequest>
        <SourceCode>string</SourceCode>
        <SourceName>string</SourceName>
        <SourceStatus>string</SourceStatus>
        <SourceStatusDesc>string</SourceStatusDesc>
        <Contact>string</Contact>
        <Salutation>string</Salutation>
        <WebSite>string</WebSite>
        <Telephone>string</Telephone>
        <Mobile>string</Mobile>
        <Email>string</Email>
        <Fax>string</Fax>
        <Notes>string</Notes>
        <SourceCategory>string</SourceCategory>
        <SourceCategoryDesc>string</SourceCategoryDesc>
        <SourceArea>string</SourceArea>
        <SourceAreaDesc>string</SourceAreaDesc>
        <SourceRegion>string</SourceRegion>
        <SourceRegionDesc>string</SourceRegionDesc>
        <SourceReference>string</SourceReference>
        <SourceBrokerNetworks>
          <BrokerNetwork>
            <BrokerNetworkCompanyName>string</BrokerNetworkCompanyName>
          </BrokerNetwork>
          <BrokerNetwork>
            <BrokerNetworkCompanyName>string</BrokerNetworkCompanyName>
          </BrokerNetwork>
        </SourceBrokerNetworks>
        <DistanceFromCurrent>double</DistanceFromCurrent>
        <SourceAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </SourceAddress>
        <SourceCaseDetail>
          <TotalCases>int</TotalCases>
          <TotalCompletedCases>int</TotalCompletedCases>
          <TotalCancelledCases>int</TotalCancelledCases>
          <TotalInProgressCases>int</TotalInProgressCases>
          <TotalLoan>double</TotalLoan>
        </SourceCaseDetail>
        <SourceTypes>
          <SourceType>
            <SourceType>string</SourceType>
          </SourceType>
          <SourceType>
            <SourceType>string</SourceType>
          </SourceType>
        </SourceTypes>
        <SourceRep>int</SourceRep>
        <SourceLead>int</SourceLead>
        <SourceStatementText>string</SourceStatementText>
        <SourceCreatedDate>string</SourceCreatedDate>
        <Additional1User>string</Additional1User>
        <Additional1UserName>string</Additional1UserName>
        <Additional2User>string</Additional2User>
        <Additional2UserName>string</Additional2UserName>
        <SourceAffiliates>
          <SourceAffiliateResult>
            <SourceAffiliateCode>string</SourceAffiliateCode>
            <SourceAffiliateName>string</SourceAffiliateName>
            <SourceAffiliateAddress xsi:nil="true" />
            <Contact>string</Contact>
            <WebSite>string</WebSite>
            <Telephone>string</Telephone>
            <Fax>string</Fax>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <Salutation>string</Salutation>
            <SourceAffiliateStatus>string</SourceAffiliateStatus>
            <SourceAffiliateStatusDesc>string</SourceAffiliateStatusDesc>
            <SourceAffiliateType>string</SourceAffiliateType>
            <SourceAffiliateTypeDesc>string</SourceAffiliateTypeDesc>
            <SourceAffiliateRegion>string</SourceAffiliateRegion>
            <SourceAffiliateRegionDesc>string</SourceAffiliateRegionDesc>
          </SourceAffiliateResult>
          <SourceAffiliateResult>
            <SourceAffiliateCode>string</SourceAffiliateCode>
            <SourceAffiliateName>string</SourceAffiliateName>
            <SourceAffiliateAddress xsi:nil="true" />
            <Contact>string</Contact>
            <WebSite>string</WebSite>
            <Telephone>string</Telephone>
            <Fax>string</Fax>
            <Mobile>string</Mobile>
            <Email>string</Email>
            <Salutation>string</Salutation>
            <SourceAffiliateStatus>string</SourceAffiliateStatus>
            <SourceAffiliateStatusDesc>string</SourceAffiliateStatusDesc>
            <SourceAffiliateType>string</SourceAffiliateType>
            <SourceAffiliateTypeDesc>string</SourceAffiliateTypeDesc>
            <SourceAffiliateRegion>string</SourceAffiliateRegion>
            <SourceAffiliateRegionDesc>string</SourceAffiliateRegionDesc>
          </SourceAffiliateResult>
        </SourceAffiliates>
        <EnableCommission>boolean</EnableCommission>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateSource>
  </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>
    <CreateSourceResponse xmlns="http://tempuri.org/">
      <CreateSourceResult>
        <EnquiryResult>
          <SuccessCode>SUCCESS or SYSTEMERROR or LOGINERROR or OTHER or MISSINGRECORD or PARAMETERERROR</SuccessCode>
          <Message>string</Message>
          <ExceptionMessage>string</ExceptionMessage>
          <IsSystemError>boolean</IsSystemError>
        </EnquiryResult>
        <Records>
          <anyType />
          <anyType />
        </Records>
        <TotalRecordCount>int</TotalRecordCount>
      </CreateSourceResult>
    </CreateSourceResponse>
  </soap12:Body>
</soap12:Envelope>