| Name | Description | Type | Additional information |
|---|---|---|---|
| PartnerId |
Partner Id |
integer |
Required |
| CommunityId |
Reference Community Id |
integer |
Required |
| PlanId |
Plan Id |
integer |
None. |
| SpecId |
Specification Id |
integer |
None. |
| reconumber |
Number of Recommendations Requested |
integer |
Required |
| PresentedExclude |
Controls whether it will apply the Presentation Check from the Recommended Communities Duplicate Prevention rule set |
boolean |
None. |
| PreviouslySentExclude |
Controls whether it will apply the Delivery Check from the Recommended Communities Duplicate Prevention rule set |
boolean |
None. |
| orfb |
OnlyResultFromBuilder |
boolean |
None. |
| onlyresultfrombrand | boolean |
None. |
|
| ebfr |
ExcludeBuilderFromResults |
boolean |
None. |
| excludebrandresults | boolean |
None. |
|
|
|
string |
None. |
|
| IsMixOfHomeType |
IsMixOfHomeType |
boolean |
None. |
| BedroomMin |
BedroomMin |
integer |
None. |
| BedroomMax |
Ignored If its null |
integer |
None. |
| PricePadding |
PricePadding |
integer |
None. |
| Days |
Days |
integer |
None. |
| IsComRequest |
IsComRequest |
boolean |
None. |
| PriceLowRefCom |
PriceLowRefCom |
integer |
None. |
| PriceHighRefCom |
PriceHighRefCom |
integer |
None. |
| Radius |
Radius |
integer |
None. |
| PriceLow |
PriceLow |
integer |
None. |
| PriceHigh |
PriceHigh |
integer |
None. |
| HomeType |
HomeType |
string |
None. |
| Adult |
Adult |
boolean |
None. |
| BuilderId |
BuilderId |
integer |
None. |
| OriginLat |
OriginLat |
decimal number |
None. |
| OriginLong |
OriginLong |
decimal number |
None. |
| MarketId |
MarketId |
integer |
None. |
| ExcludeCommunityId |
ExcludeCommunityId |
integer |
None. |
| PostalCode |
PostalCode |
string |
None. |
| City |
City |
string |
None. |
| IsBasicCommunity |
IsBasicCommunity |
boolean |
None. |
| BasicHomeId |
BasicHomeId |
integer |
None. |
| TownHome |
Is Condo or TownHome |
boolean |
None. |
| FillWithOtherBldrs |
If the result count is less that the number of recommendations requested, fills the response with other builders recommendations . |
boolean |
None. |
| FillWithOtherBrands | boolean |
None. |
|
| ParentCommunityId |
ParentCommunityId |
integer |
None. |
| IsAPaidMpc |
IsAPaidMpc |
boolean |
None. |
| DoesCommunityBelongsToMpc |
DoesCommunityBelongsToMpc |
boolean |
None. |
| MpcAssociatedCommunitiesIds |
MpcAssociatedCommunitiesIds |
List of integer |
None. |
| ExcludeProjectTypes |
ExcludeProjectTypes |
List of string |
None. |
| IsBoyl |
Reference Comm is Boyl |
boolean |
None. |
| IsCustom | boolean |
None. |
|
| includecomsoncomm |
IncludeComingSoonCommunity |
boolean |
None. |
| FilterByPlan |
FilterByPlan |
boolean |
None. |
| FilterByAdult |
FilterByAdult |
boolean |
None. |
| FilterByPrice |
FilterByPrice |
boolean |
None. |
| filterhomesbybedrooms |
FilterHomesByNumberOfBedrooms |
boolean |
None. |
| UsedMid |
UsedMid |
boolean |
None. |
| BasicSearch |
BasicSearch |
boolean |
None. |
| RelaxSearchCriteria |
Relax Search Criteria |
boolean |
None. |
| IsAvailable |
IsAvailable |
boolean |
None. |
| AggregateOptions |
AggregateOptions |
boolean |
None. |
| BrandId | integer |
None. |
|
| Client |
Client |
string |
None. |