This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Recommendations
Search Parameters
More details here
URI Parameters
| 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. |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"SearchParams": {
"PartnerId": 1,
"CommunityId": 2,
"PlanId": 3,
"SpecId": 4,
"NumberOfRecomendations": 5,
"PresentedExclude": true,
"PreviouslySentExclude": true,
"OnlyResultFromBuilder": true,
"OnlyResultFromBrand": true,
"ExcludeBuilderFromResults": true,
"ExcludeBrandResults": true,
"Email": "sample string 12",
"IsMixOfHomeType": true,
"BedroomMin": 14,
"BedroomMax": 1,
"PricePadding": 15,
"Days": 16,
"IsComRequest": true,
"PriceLowRefCom": 18,
"PriceHighRefCom": 19,
"Radius": 20,
"PriceLow": 21,
"PriceHigh": 22,
"HomeType": "sample string 23",
"Adult": true,
"BuilderId": 25,
"OriginLat": 26.1,
"OriginLong": 27.1,
"MarketId": 28,
"ExcludeCommunityId": 29,
"PostalCode": "sample string 30",
"City": "sample string 31",
"IsBasicCommunity": true,
"BasicHomeId": 33,
"TownHome": true,
"FillWithOtherBldrs": true,
"FillWithOtherBrands": true,
"ParentCommunityId": 37,
"IsAPaidMpc": true,
"DoesCommunityBelongsToMpc": true,
"MpcAssociatedCommunitiesIds": [
1,
2
],
"ExcludeProjectTypes": [
"sample string 1",
"sample string 2"
],
"IsBoyl": true,
"IsCustom": true,
"IncludeComingSoonCommunity": true,
"FilterByPlan": true,
"FilterByAdult": true,
"FilterByPrice": true,
"FilterHomesByNumberOfBedrooms": true,
"UsedMid": true,
"BasicSearch": true,
"RelaxSearchCriteria": true,
"IsAvailable": true,
"AggregateOptions": true,
"BrandId": 52
},
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": [
{
"CommunityId": 1,
"CommunityName": "sample string 2",
"CommunityImageThumbnail": "sample string 3",
"CommunityType": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"Green": true,
"HasHotHome": true,
"PromoId": 9,
"SubVideoFlag": "sample string 10",
"BuilderId": 11,
"BuilderUrl": "sample string 12",
"PriceLow": 13.0,
"PriceHigh": 14.0,
"MarketId": 15,
"MarketName": "sample string 16",
"PostalCode": "sample string 17",
"PhoneNumber": "sample string 18",
"County": "sample string 19",
"BrandId": 20,
"BrandName": "sample string 21",
"BrandLogo": "sample string 22",
"Address": "sample string 23",
"City": "sample string 24",
"State": "sample string 25",
"IsCondo": true,
"IsTownHome": true,
"Distance": 28.1,
"HaveSingleFamilyPlans": true,
"HaveMultiFamilyPlans": true,
"ShowDevNm": true,
"ProjectType": "sample string 32"
},
{
"CommunityId": 1,
"CommunityName": "sample string 2",
"CommunityImageThumbnail": "sample string 3",
"CommunityType": "sample string 4",
"Latitude": 5.1,
"Longitude": 6.1,
"Green": true,
"HasHotHome": true,
"PromoId": 9,
"SubVideoFlag": "sample string 10",
"BuilderId": 11,
"BuilderUrl": "sample string 12",
"PriceLow": 13.0,
"PriceHigh": 14.0,
"MarketId": 15,
"MarketName": "sample string 16",
"PostalCode": "sample string 17",
"PhoneNumber": "sample string 18",
"County": "sample string 19",
"BrandId": 20,
"BrandName": "sample string 21",
"BrandLogo": "sample string 22",
"Address": "sample string 23",
"City": "sample string 24",
"State": "sample string 25",
"IsCondo": true,
"IsTownHome": true,
"Distance": 28.1,
"HaveSingleFamilyPlans": true,
"HaveMultiFamilyPlans": true,
"ShowDevNm": true,
"ProjectType": "sample string 32"
}
]
}
<Root>
<SearchParams>
<PartnerId>1</PartnerId>
<CommunityId>2</CommunityId>
<PlanId>3</PlanId>
<SpecId>4</SpecId>
<NumberOfRecomendations>5</NumberOfRecomendations>
<PresentedExclude>true</PresentedExclude>
<PreviouslySentExclude>true</PreviouslySentExclude>
<OnlyResultFromBuilder>true</OnlyResultFromBuilder>
<OnlyResultFromBrand>true</OnlyResultFromBrand>
<ExcludeBuilderFromResults>true</ExcludeBuilderFromResults>
<ExcludeBrandResults>true</ExcludeBrandResults>
<Email>sample string 12</Email>
<IsMixOfHomeType>true</IsMixOfHomeType>
<BedroomMin>14</BedroomMin>
<BedroomMax>1</BedroomMax>
<PricePadding>15</PricePadding>
<Days>16</Days>
<IsComRequest>true</IsComRequest>
<PriceLowRefCom>18</PriceLowRefCom>
<PriceHighRefCom>19</PriceHighRefCom>
<Radius>20</Radius>
<PriceLow>21</PriceLow>
<PriceHigh>22</PriceHigh>
<HomeType>sample string 23</HomeType>
<Adult>true</Adult>
<BuilderId>25</BuilderId>
<OriginLat>26.1</OriginLat>
<OriginLong>27.1</OriginLong>
<MarketId>28</MarketId>
<ExcludeCommunityId>29</ExcludeCommunityId>
<PostalCode>sample string 30</PostalCode>
<City>sample string 31</City>
<IsBasicCommunity>true</IsBasicCommunity>
<BasicHomeId>33</BasicHomeId>
<TownHome>true</TownHome>
<FillWithOtherBldrs>true</FillWithOtherBldrs>
<FillWithOtherBrands>true</FillWithOtherBrands>
<ParentCommunityId>37</ParentCommunityId>
<IsAPaidMpc>true</IsAPaidMpc>
<DoesCommunityBelongsToMpc>true</DoesCommunityBelongsToMpc>
<MpcAssociatedCommunitiesIds>1</MpcAssociatedCommunitiesIds>
<MpcAssociatedCommunitiesIds>2</MpcAssociatedCommunitiesIds>
<ExcludeProjectTypes>sample string 1</ExcludeProjectTypes>
<ExcludeProjectTypes>sample string 2</ExcludeProjectTypes>
<IsBoyl>true</IsBoyl>
<IsCustom>true</IsCustom>
<IncludeComingSoonCommunity>true</IncludeComingSoonCommunity>
<FilterByPlan>true</FilterByPlan>
<FilterByAdult>true</FilterByAdult>
<FilterByPrice>true</FilterByPrice>
<FilterHomesByNumberOfBedrooms>true</FilterHomesByNumberOfBedrooms>
<UsedMid>true</UsedMid>
<BasicSearch>true</BasicSearch>
<RelaxSearchCriteria>true</RelaxSearchCriteria>
<IsAvailable>true</IsAvailable>
<AggregateOptions>true</AggregateOptions>
<BrandId>52</BrandId>
</SearchParams>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>
<CommunityId>1</CommunityId>
<CommunityName>sample string 2</CommunityName>
<CommunityImageThumbnail>sample string 3</CommunityImageThumbnail>
<CommunityType>sample string 4</CommunityType>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Green>true</Green>
<HasHotHome>true</HasHotHome>
<PromoId>9</PromoId>
<SubVideoFlag>sample string 10</SubVideoFlag>
<BuilderId>11</BuilderId>
<BuilderUrl>sample string 12</BuilderUrl>
<PriceLow>13</PriceLow>
<PriceHigh>14</PriceHigh>
<MarketId>15</MarketId>
<MarketName>sample string 16</MarketName>
<PostalCode>sample string 17</PostalCode>
<PhoneNumber>sample string 18</PhoneNumber>
<County>sample string 19</County>
<BrandId>20</BrandId>
<BrandName>sample string 21</BrandName>
<BrandLogo>sample string 22</BrandLogo>
<Address>sample string 23</Address>
<City>sample string 24</City>
<State>sample string 25</State>
<IsCondo>true</IsCondo>
<IsTownHome>true</IsTownHome>
<Distance>28.1</Distance>
<HaveSingleFamilyPlans>true</HaveSingleFamilyPlans>
<HaveMultiFamilyPlans>true</HaveMultiFamilyPlans>
<ShowDevNm>true</ShowDevNm>
<ProjectType>sample string 32</ProjectType>
</Result>
<Result>
<CommunityId>1</CommunityId>
<CommunityName>sample string 2</CommunityName>
<CommunityImageThumbnail>sample string 3</CommunityImageThumbnail>
<CommunityType>sample string 4</CommunityType>
<Latitude>5.1</Latitude>
<Longitude>6.1</Longitude>
<Green>true</Green>
<HasHotHome>true</HasHotHome>
<PromoId>9</PromoId>
<SubVideoFlag>sample string 10</SubVideoFlag>
<BuilderId>11</BuilderId>
<BuilderUrl>sample string 12</BuilderUrl>
<PriceLow>13</PriceLow>
<PriceHigh>14</PriceHigh>
<MarketId>15</MarketId>
<MarketName>sample string 16</MarketName>
<PostalCode>sample string 17</PostalCode>
<PhoneNumber>sample string 18</PhoneNumber>
<County>sample string 19</County>
<BrandId>20</BrandId>
<BrandName>sample string 21</BrandName>
<BrandLogo>sample string 22</BrandLogo>
<Address>sample string 23</Address>
<City>sample string 24</City>
<State>sample string 25</State>
<IsCondo>true</IsCondo>
<IsTownHome>true</IsTownHome>
<Distance>28.1</Distance>
<HaveSingleFamilyPlans>true</HaveSingleFamilyPlans>
<HaveMultiFamilyPlans>true</HaveMultiFamilyPlans>
<ShowDevNm>true</ShowDevNm>
<ProjectType>sample string 32</ProjectType>
</Result>
</Root>
Code Generator
Response Information
ApiRecoResultModelOfIEnumerableOfApiRecoCommunityResult
| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchParams | ApiRecoSearchParams |
None. |
|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | List of ApiRecoCommunityResult |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
GET
api/v2/Search/Recommendations