API Kerbside - New API Kerbside Fields

New API Kerbside Fields

Below is a list of fields that currently come through for Kerbsides that are now required for FullRegistered when it’s a Kerbside.

Kerbside Identification

The data should be identified as being a Kerbside response by:

Field XPath Value
ValSubType  //FullRegistered/@ValSubType ShortForm
SubTypeNote  //FullRegistered/SubTypeNote Kerbside

Example:

<ValuationType>    <Identifier UniqueID="" Type="VPMAssigned"/>    <FullRegistered ValSubType="ShortForm">       <SubTypeNote>Kerbside</SubTypeNote>

External Inspection Not Appropriate

If an external inspection is not appropriate the comment as to why should be entered in //FullRegistered/Disclaimer. If the kerbside is appropriate the disclaimer element should either be dropped all together or it should be left blank.

Field XPath
Disclaimer  //FullRegistered/Disclaimer

Example where external is not appropriate:

<ValuationType>    <Identifier UniqueID="" Type="VPMAssigned"/>    <FullRegistered ValSubType="ShortForm">       <SubTypeNote>Kerbside</SubTypeNote>       ...       <Disclaimer>The property is obscured by trees. Need to enter the property to inspect.</Disclaimer>

Example where the kerbside can be used:

<ValuationType>    <Identifier UniqueID="" Type="VPMAssigned"/>    <FullRegistered ValSubType="ShortForm">       <SubTypeNote>Kerbside</SubTypeNote>       ...       <Disclaimer></Disclaimer>

Value Range

Kerbsides require a range to be sent through. This can be done by the following:

Field XPath
Lower Value  //FullRegistered/ValueComponent/MarketValueAsIfComplete/@ValueFloor
Upper Value //FullRegistered/ValueComponent/MarketValueAsIfComplete/@ValueCeiling

Example:

<ValuationType>    <Identifier UniqueID="" Type="VPMAssigned"/>    <FullRegistered ValSubType="ShortForm">       <SubTypeNote>Kerbside</SubTypeNote>       ...       <ValueComponent>          <MarketValueAsIfComplete ValueFloor="220000" ValueCeiling="280000"/>