BrightofficeAPI

Click here for a complete list of operations.

CreateCaseAsset

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

<?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>
    <CreateCaseAsset xmlns="http://tempuri.org/">
      <pRequest>
        <CaseReference>string</CaseReference>
        <AssetAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </AssetAddress>
        <CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomField>
        <AssetType>string</AssetType>
        <AssetTypeProperty>string</AssetTypeProperty>
        <AssetCharge>string</AssetCharge>
        <AssetDescription>string</AssetDescription>
        <PropertyLink1>string</PropertyLink1>
        <PropertyLink2>string</PropertyLink2>
        <PropertyLink3>string</PropertyLink3>
        <MortgageValue>decimal</MortgageValue>
        <value>decimal</value>
        <PurchaseValue>decimal</PurchaseValue>
        <PurchaseDate>dateTime</PurchaseDate>
        <AssetStatusCode>string</AssetStatusCode>
        <MarketValuePerc>decimal</MarketValuePerc>
        <MarketValuePercEdited>decimal</MarketValuePercEdited>
        <LendingValue>decimal</LendingValue>
        <EquityValue>decimal</EquityValue>
        <PrimaryAsset>boolean</PrimaryAsset>
        <Notes>string</Notes>
        <ThirdPartyCharge>boolean</ThirdPartyCharge>
        <ChargeValue>decimal</ChargeValue>
        <AgreedCap>decimal</AgreedCap>
        <ChargeDate>dateTime</ChargeDate>
        <DV90Days>decimal</DV90Days>
        <GDV90Days>decimal</GDV90Days>
        <DV180Days>decimal</DV180Days>
        <GDV180Days>decimal</GDV180Days>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateCaseAsset>
  </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>
    <CreateCaseAssetResponse xmlns="http://tempuri.org/">
      <CreateCaseAssetResult>
        <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>
      </CreateCaseAssetResult>
    </CreateCaseAssetResponse>
  </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>
    <CreateCaseAsset xmlns="http://tempuri.org/">
      <pRequest>
        <CaseReference>string</CaseReference>
        <AssetAddress>
          <HouseName>string</HouseName>
          <HouseNumber>string</HouseNumber>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <Address3>string</Address3>
          <Address4>string</Address4>
          <Address5>string</Address5>
          <PostCode>string</PostCode>
        </AssetAddress>
        <CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
          <CustomField>
            <index>int</index>
            <CustomFieldLabel>string</CustomFieldLabel>
            <CustomFieldValue>string</CustomFieldValue>
          </CustomField>
        </CustomField>
        <AssetType>string</AssetType>
        <AssetTypeProperty>string</AssetTypeProperty>
        <AssetCharge>string</AssetCharge>
        <AssetDescription>string</AssetDescription>
        <PropertyLink1>string</PropertyLink1>
        <PropertyLink2>string</PropertyLink2>
        <PropertyLink3>string</PropertyLink3>
        <MortgageValue>decimal</MortgageValue>
        <value>decimal</value>
        <PurchaseValue>decimal</PurchaseValue>
        <PurchaseDate>dateTime</PurchaseDate>
        <AssetStatusCode>string</AssetStatusCode>
        <MarketValuePerc>decimal</MarketValuePerc>
        <MarketValuePercEdited>decimal</MarketValuePercEdited>
        <LendingValue>decimal</LendingValue>
        <EquityValue>decimal</EquityValue>
        <PrimaryAsset>boolean</PrimaryAsset>
        <Notes>string</Notes>
        <ThirdPartyCharge>boolean</ThirdPartyCharge>
        <ChargeValue>decimal</ChargeValue>
        <AgreedCap>decimal</AgreedCap>
        <ChargeDate>dateTime</ChargeDate>
        <DV90Days>decimal</DV90Days>
        <GDV90Days>decimal</GDV90Days>
        <DV180Days>decimal</DV180Days>
        <GDV180Days>decimal</GDV180Days>
      </pRequest>
      <UserInfo>
        <Username>string</Username>
        <Password>string</Password>
      </UserInfo>
    </CreateCaseAsset>
  </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>
    <CreateCaseAssetResponse xmlns="http://tempuri.org/">
      <CreateCaseAssetResult>
        <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>
      </CreateCaseAssetResult>
    </CreateCaseAssetResponse>
  </soap12:Body>
</soap12:Envelope>