GET api/analysis/{propertyAddressId}/validate-comparable/{compPropertyAddressId}
This method will validate comparable property against a target subject property to ensure it is a proper comparable property and can be used for Assessment Analysis report.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| propertyAddressId |
Property Address Id of the subject property |
integer |
Required |
| compPropertyAddressId |
Property Address Id of the comparable property |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Instance of
ComparablePropertyValidationResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SubjectPropertyAddressId | integer |
None. |
|
| ComparablePropertyAddressId | integer |
None. |
|
| IsValid | boolean |
None. |
|
| ValidationWarning | Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"subjectPropertyAddressId": 1,
"comparablePropertyAddressId": 2,
"isValid": true,
"validationWarning": [
"sample string 1",
"sample string 2"
]
}
text/html
Sample:
{"subjectPropertyAddressId":1,"comparablePropertyAddressId":2,"isValid":true,"validationWarning":["sample string 1","sample string 2"]}
application/xml, text/xml
Sample:
<ComparablePropertyValidationResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos.TaxAnalysis">
<ComparablePropertyAddressId>2</ComparablePropertyAddressId>
<IsValid>true</IsValid>
<SubjectPropertyAddressId>1</SubjectPropertyAddressId>
<ValidationWarning xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ValidationWarning>
</ComparablePropertyValidationResponseModel>