GET api/analysis/{propertyAddressId}/search-compare-menu?showAllNeighborhoods={showAllNeighborhoods}

This method will return menu items for search and compare screen that should be displayed and provided to users during the analysis of a specific subject property

Request Information

URI Parameters

Name	Description	Type	Additional information
propertyAddressId	Property address id of subject property	integer	Required
showAllNeighborhoods	Bool flag to trigger return of properties from all neighborhoods	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Instance of

SearchMenuOptionPo

Name	Type	Additional information
Townships	Collection of MenuItem	None.
Cities	Collection of MenuItem	None.
Neighborhoods	Collection of MenuItem	None.
TaxCodes	Collection of MenuItem	None.
ResidenceTypes	Collection of MenuItem	None.
PropertyClasses	Collection of MenuItem	None.
ConstructionTypes	Collection of MenuItem	None.
FullBaths	Collection of integer	None.
HalfBaths	Collection of integer	None.
NumFireplaces	Collection of integer	None.
BasementTypes	Collection of MenuItem	None.
AtticTypes	Collection of MenuItem	None.
GarageTypes	Collection of MenuItem	None.
MinBuildingArea	decimal number	None.
MaxBuildingArea	decimal number	None.
MinLandArea	decimal number	None.
MaxLandArea	decimal number	None.
MinAge	integer	None.
MaxAge	integer	None.
BuildingUse	Collection of MenuItem	None.
Apartments	Collection of integer	None.
Cdu	Collection of MenuItem	None.
Style	Collection of MenuItem	None.
Grade	Collection of MenuItem	None.
ExternalWallType	Collection of MenuItem	None.
Bedrooms	Collection of integer	None.
MinGfla	integer	None.
MaxGfla	integer	None.
MinBasementArea	integer	None.
MaxBasementArea	integer	None.
MinRecRoomArea	integer	None.
MaxRecRoomArea	integer	None.
TotalFixtures	Collection of integer	None.
LandUseCodes	Collection of MenuItem	None.
HasDeck	boolean	None.
HasConcretePatio	boolean	None.
HasEnclosedPorch	boolean	None.
HasOpenPorch	boolean	None.
HasGroundPool	boolean	None.
HasShed	boolean	None.
HasGazebo	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "townships": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "cities": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "neighborhoods": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "taxCodes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "residenceTypes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "propertyClasses": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "constructionTypes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "fullBaths": [
    1,
    2
  ],
  "halfBaths": [
    1,
    2
  ],
  "numFireplaces": [
    1,
    2
  ],
  "basementTypes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "atticTypes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "garageTypes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "minBuildingArea": 1.1,
  "maxBuildingArea": 1.1,
  "minLandArea": 1.1,
  "maxLandArea": 1.1,
  "minAge": 1,
  "maxAge": 1,
  "buildingUse": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "apartments": [
    1,
    2
  ],
  "cdu": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "style": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "grade": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "externalWallType": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "bedrooms": [
    1,
    1
  ],
  "minGfla": 1,
  "maxGfla": 2,
  "minBasementArea": 3,
  "maxBasementArea": 4,
  "minRecRoomArea": 5,
  "maxRecRoomArea": 6,
  "totalFixtures": [
    1,
    1
  ],
  "landUseCodes": [
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    },
    {
      "id": 1,
      "option": "sample string 2",
      "rating": 3
    }
  ],
  "hasDeck": true,
  "hasConcretePatio": true,
  "hasEnclosedPorch": true,
  "hasOpenPorch": true,
  "hasGroundPool": true,
  "hasShed": true,
  "hasGazebo": true
}

text/html

Sample:

{"townships":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"cities":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"neighborhoods":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"taxCodes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"residenceTypes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"propertyClasses":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"constructionTypes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"fullBaths":[1,2],"halfBaths":[1,2],"numFireplaces":[1,2],"basementTypes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"atticTypes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"garageTypes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"minBuildingArea":1.1,"maxBuildingArea":1.1,"minLandArea":1.1,"maxLandArea":1.1,"minAge":1,"maxAge":1,"buildingUse":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"apartments":[1,2],"cdu":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"style":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"grade":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"externalWallType":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"bedrooms":[1,1],"minGfla":1,"maxGfla":2,"minBasementArea":3,"maxBasementArea":4,"minRecRoomArea":5,"maxRecRoomArea":6,"totalFixtures":[1,1],"landUseCodes":[{"id":1,"option":"sample string 2","rating":3},{"id":1,"option":"sample string 2","rating":3}],"hasDeck":true,"hasConcretePatio":true,"hasEnclosedPorch":true,"hasOpenPorch":true,"hasGroundPool":true,"hasShed":true,"hasGazebo":true}

application/xml, text/xml

Sample:

<SearchMenuOptionPo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.Pos">
  <Apartments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Apartments>
  <AtticTypes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </AtticTypes>
  <BasementTypes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </BasementTypes>
  <Bedrooms xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </Bedrooms>
  <BuildingUse>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </BuildingUse>
  <Cdu>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Cdu>
  <Cities>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Cities>
  <ConstructionTypes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </ConstructionTypes>
  <ExternalWallType>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </ExternalWallType>
  <FullBaths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FullBaths>
  <GarageTypes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </GarageTypes>
  <Grade>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Grade>
  <HalfBaths xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </HalfBaths>
  <HasConcretePatio>true</HasConcretePatio>
  <HasDeck>true</HasDeck>
  <HasEnclosedPorch>true</HasEnclosedPorch>
  <HasGazebo>true</HasGazebo>
  <HasGroundPool>true</HasGroundPool>
  <HasOpenPorch>true</HasOpenPorch>
  <HasShed>true</HasShed>
  <LandUseCodes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </LandUseCodes>
  <MaxAge>1</MaxAge>
  <MaxBasementArea>4</MaxBasementArea>
  <MaxBuildingArea>1.1</MaxBuildingArea>
  <MaxGfla>2</MaxGfla>
  <MaxLandArea>1.1</MaxLandArea>
  <MaxRecRoomArea>6</MaxRecRoomArea>
  <MinAge>1</MinAge>
  <MinBasementArea>3</MinBasementArea>
  <MinBuildingArea>1.1</MinBuildingArea>
  <MinGfla>1</MinGfla>
  <MinLandArea>1.1</MinLandArea>
  <MinRecRoomArea>5</MinRecRoomArea>
  <Neighborhoods>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Neighborhoods>
  <NumFireplaces xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NumFireplaces>
  <PropertyClasses>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </PropertyClasses>
  <ResidenceTypes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </ResidenceTypes>
  <Style>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Style>
  <TaxCodes>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </TaxCodes>
  <TotalFixtures xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </TotalFixtures>
  <Townships>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
    <MenuItem>
      <Id>1</Id>
      <Option>sample string 2</Option>
      <Rating>3</Rating>
    </MenuItem>
  </Townships>
</SearchMenuOptionPo>