This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Get Basic Listing by Id.
Parameters:
- PartnerId
- ListingId
- BackFillImages
- IncludeBookmarks
- UserId (required when using IncludeBookmarks)
- ExcludeParams
- AggregateOptions
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
partnerId |
Required Partner Id. |
integer |
Required |
listingId |
Required Listing Id. |
integer |
Required |
Response
Sample not available.
Sample not available.
Code Generator
Response Information
ApiHome.
ApiHomeName | Description | Type | Additional information |
---|---|---|---|
Message | string |
None. |
|
HomeId |
Home Id |
integer |
None. |
ListingId |
Listing Id |
integer |
None. |
ListingTitle | string |
None. |
|
ListingNumber | string |
None. |
|
IsSpec |
Used to know if it is a spec |
boolean |
None. |
PlanId |
Plan Id |
integer |
None. |
PlanName |
Plan Name for the home |
string |
None. |
SpecNum |
Spec Number |
string |
None. |
Desc |
Home Description |
string |
None. |
IsDescAutoGenerated |
Usued to know if the description is auto generated |
integer |
None. |
MoveInDate |
Date available to move to the home |
string |
None. |
MarketingDesc |
Marketing Description |
string |
None. |
Addr |
Home Address |
string |
None. |
City |
Home City |
string |
None. |
County |
Home County |
string |
None. |
State |
Home State |
string |
None. |
Zip |
Home Zip |
string |
None. |
Br |
Home Bedrooms (Ignored if is null) |
integer |
None. |
BrLo |
Bedrooms Low (Ignored if is null) |
integer |
None. |
BrHi |
Bedrooms High (Ignored if is null) |
integer |
None. |
MasterBedroomLocation |
Master Bedroom Location |
integer |
None. |
Ba |
Home Bathrooms (Ignored if is null) |
integer |
None. |
BaLo |
Bathrooms Low (Ignored if is null) |
integer |
None. |
BaHi |
Bathrooms High (Ignored if is null) |
integer |
None. |
DisplayAddress | boolean |
None. |
|
FeedProviderId | integer |
None. |
|
HBa |
Home Half Bathrooms (Ignored if is null) |
integer |
None. |
HBaLo |
Half Bathrooms Low (Ignored if is null) |
integer |
None. |
HBaHi |
Half Bathrooms High (Ignored if is null) |
integer |
None. |
St |
Home Stories (Ignored if is null) |
decimal number |
None. |
StLo |
Stories Low (Ignored if is null) |
decimal number |
None. |
StHi |
Stories High (Ignored if is null) |
decimal number |
None. |
Gr |
Home Garages (Ignored if is null) |
decimal number |
None. |
GrLo |
Garages Low (Ignored if is null) |
decimal number |
None. |
GrHi |
Garages High (Ignored if is null) |
decimal number |
None. |
Sft |
Home Square Feet (Ignored if is null) |
integer |
None. |
SftLo |
Square Feet Low (Ignored if is null) |
integer |
None. |
SftHi |
Square Feet High (Ignored if is null) |
integer |
None. |
LotSft |
Lot Square Feet |
integer |
None. |
LotNumber |
Lot number |
string |
None. |
Price |
Home price |
decimal number |
None. |
PriceLo |
Price low (Ignored if is null) |
decimal number |
None. |
PriceHi |
Price high (Ignored if is null) |
decimal number |
None. |
ModelPrice |
Model price |
decimal number |
None. |
ProviderUrl | string |
None. |
|
NumLivingAreas |
Number of living areas |
integer |
None. |
Status |
Home Status
|
string |
None. |
IsHotHome |
Used to know if it is a Hot Home |
integer |
None. |
Thumb |
Small image for the home |
string |
None. |
Phone |
Home or Community Phone |
string |
None. |
PhoneTracking |
Community Phone Tracking |
string |
None. |
IsTrackingNumber |
Is Phone Number a Call Tracking Number |
boolean |
None. |
MktId |
Market Id |
integer |
None. |
MarketName |
Community Market Name |
string |
None. |
MarketStateAbbr | string |
None. |
|
MarketStateName | string |
None. |
|
MlsNumber | string |
None. |
|
MlsProviderId | integer |
None. |
|
CommId |
Community Id |
integer |
None. |
CommName |
Community Name |
string |
None. |
ParentCommId |
Spec Parent Community Id |
integer |
None. |
ParentCommName |
Spec Parent Community Name |
string |
None. |
IsParentCommActive |
Is Parent Community Active |
boolean |
None. |
CommListingTypeFlag |
Community Listing Type Flag |
string |
None. |
CommType |
Community Type |
string |
None. |
CommProjectType |
Community Project Type |
string |
None. |
CommDesc |
Community Description |
string |
None. |
CommunityUrl |
Community URL |
string |
None. |
CommAddr |
Principal Community Address |
string |
None. |
CommAddr2 |
Secundary Community Address |
string |
None. |
CommCity |
Community City |
string |
None. |
CommState |
Community State |
string |
None. |
CommZip |
Community Zip |
string |
None. |
CommLat |
Community Latitude |
decimal number |
None. |
CommLng |
Community Longitude |
decimal number |
None. |
CommBannerImage |
Community Banner Image |
string |
None. |
CommPriceLow | decimal number |
None. |
|
CommPriceHigh | decimal number |
None. |
|
IsBasic |
Is Basic Home |
boolean |
None. |
SchoolDistricts |
School Districts names |
string |
None. |
Lat |
Home Latitude |
decimal number |
None. |
Lng |
Home Longitude |
decimal number |
None. |
PlanTypeId |
Plan type Id, sf(Single Family) or mf(Multi Family) |
string |
None. |
PlanTypeName |
Plan Types
|
string |
None. |
PlanBrandName |
Plan Brand Name |
string |
None. |
PlanBrandLogo |
Plan Brand Logo |
string |
None. |
Builder |
Api Builder Object |
ApiBuilder |
None. |
Brand |
Api Brand Object |
ApiBrand |
None. |
PlanViewerUrl |
URL for the plan view |
string |
None. |
TourUrl |
Tour Url |
string |
None. |
Time |
Execution Time |
string |
None. |
EnvisionUrl |
Url of the fisrt image from all the images of Specs and plans. |
string |
None. |
Images |
List of ApiImage, Spec Images |
List of ApiImage |
None. |
PlanImages |
List of ApiImage, Plan Images |
List of ApiImage |
None. |
VideoUrl |
Fisrt URL of the videos |
string |
None. |
Videos |
Listo of viedos (ApiVideo) |
List of ApiVideo |
None. |
Summaries |
List of Home Summaries |
List of ApiSummary |
None. |
PlanAmenities |
List of plan amenities. |
List of ApiSummary |
None. |
LivingAreas |
List of living areas |
List of ApiSummary |
None. |
IntMedia |
List of interactive media |
List of ApiInteractiveMedia |
None. |
CustomAmenities |
List of custom amenities |
List of ApiCustomAmenity |
None. |
HomeOptions |
List of Home Options |
List of ApiHomeOption |
None. |
Schools |
List of schools splited by ",". |
List of ApiSchoolDistrict |
None. |
Amenities |
List of amenities |
List of ApiAmenity |
None. |
Utilities |
Listo of Utilities |
List of ApiUtility |
None. |
IsActive |
Is Active Home |
boolean |
None. |
SalesOffAddr |
Principal sales office address |
string |
None. |
SalesOffAddr2 |
Secundary sales office Address |
string |
None. |
SalesOffCity |
Salese office City |
string |
None. |
SalesOffZipCode |
Sales office Zip Code |
string |
None. |
SalesOffState |
Sales office State |
string |
None. |
SalesOffEmail |
Sales office Email |
string |
None. |
SpecType |
Spec types: Gallery (G), Model (M) |
string |
None. |
SoldPrice |
Spec Sold price. |
decimal number |
None. |
SoldDate |
Spec sold date. |
date |
None. |
CommStateAbbr |
Community State Abbreviation |
string |
None. |
Hours |
Operation hours of the sales office |
string |
None. |
DrivingDirections |
Sales office driving directions |
string |
None. |
Map |
Location of builder map |
string |
None. |
LastModified |
Last date when the home was modified |
date |
None. |
CommunityMap |
Community Map |
string |
None. |
SpecSaleStatus |
Spec Sale Status |
string |
None. |
Agents |
List of Agents |
List of ApiSalesAgent |
None. |
AgentCommission |
Agent Commision |
decimal number |
None. |
Adult |
Used to know if the home is part of an Adult Community |
integer |
None. |
AgeRestricted |
Used to know if the home is part of Age Restricted Community |
integer |
None. |
GreenProgram |
Used to know if the home has a green program |
integer |
None. |
CorporationName |
The Parent Builder Name or the Builder name were saved here |
string |
None. |
PlanUrl |
Home plan url |
string |
None. |
SpecificationUrl |
Specification Url |
string |
None. |
FulfillmentCode |
Bank of America Fulfillment Code |
string |
None. |
PreferredScore |
Bank of America Community Score |
integer |
None. |
Brochures |
Spec or Plan Brochures |
List of ApiBrochure |
None. |
Bookmarks |
List of bookmarks (Ignored if is null) |
List of BookmarkAttribute |
None. |
OutOfCommunityFlag |
Used to know if the sales office is inside the community |
boolean |
None. |
IsLandExcluded |
Used to know if the Land price is included on the total home price |
boolean |
None. |
Server |
Server Name |
string |
None. |
FeesAndRates |
Fees and rates |
List of ApiFeesAndRates |
None. |
Error |
Error found on request (Ignored if is null) |
Exception |
None. |
OwnerPartner |
Returns which partner is the owner of the community |
integer |
None. |
TranslationHomeId |
Home id on translations index |
string |
None. |
TranslationCommId |
Community Translation Id |
string |
None. |
UrgencyData | List of ApiUrgencyResponse |
None. |
|
BasicListingTypeCode | string |
None. |
|
VerboseLogger | List of IVerboseLogger |
None. |
|
WebBugUrl | string |
None. |
|
YearBuilt | string |
None. |
|
AgentId | integer |
None. |
|
AugmentedRealityHomeViewer | ApiAugmentedReality |
None. |
|
AugmentedRealityHomeOnLot | ApiAugmentedReality |
None. |
|
ModelYear |
Model Year |
integer |
None. |
DimensionWidth |
Dimension width in feet |
integer |
None. |
DimensionHeight |
Dimension height in feet |
integer |
None. |
DimensionLength | integer |
None. |
|
SectionCount |
|
string |
None. |
BuildingMethod |
|
string |
None. |
SchedulerUrl | string |
None. |