Hot Sheets Web Service

This Web Service, located at https://secure.idxre.com/ihws/HotSheetsWebService.cfc?wsdl, exposes the following four methods:

· getAllHotSheets: returns XML containing all Hot Sheets (HotSheetID, displayName, description). Takes the following arguments:

o uid – company’s iHomefinder client ID number

o sid – company’s iHomefinder password

· getHotSheet: returns XML containing all Hot Sheet information and any MLS listings attached to the Hot Sheet. Takes the following arguments:

o uid – company’s iHomefinder client ID number

o sid – company’s iHomefinder password

o hsid – Hot Sheet ID

· addHotSheet: adds Hot Sheet info to database based on client's id and XML data. Takes the following arguments:

o uid – company’s iHomefinder client ID number

o sid – company’s iHomefinder password

o xmlData – Hot Sheet information and MLS listings in XML format. An example xmlData parameter for an "Add listings by MLS NUMBER" type Hot Sheet can be viewed here.  An example xmlData parameter for a "Search the MLS" type Hot Sheet can be viewed here. The xmlData string must have a root element of "HotSheet" and may contain the following child elements:

§ displayName – Hot Sheet Display Name

§ header – Design Branding Header

§ showOnMasterYN – Show on Master Hot Sheet

§ description – Description Displayed on Master Hot Sheet

§ footer – Design Branding Footer

§ displayOrder – Order of Hot Sheet on Master List

§ displayText – Intro Text Displayed on Hot Sheet

Listings Info: ("Add listings by MLS NUMBER" type Hot Sheets only)

§ listingNumber – MLS Listing Number

§ boardID – iHomefinder MLS Board ID

§ comments – Comments to be Displayed with Listing on Hot Sheet

§ displayOrder – Order Listing is Displayed on Hot Sheet

Search Profile Info: ("Search the MLS" type Hot Sheets only)

§ inclusiveYN – If value is "1", widens search with City, Zip, Sub Area, Subdivision, Neighborhood, and other geographic settings (more listings). If value is "0", narrows search with City, Zip, Sub Area, Subdivision, Neighborhood, and other geographic settings (less listings).

§ featuredOnlyYN – Limits Search to Featured Properties Only

§ cityID – iHomefinder City ID(s)

§ zip – Zip Code(s)

§ minListPrice – Minimum List Price

§ maxListPrice – Maximum List Price

§ bedrooms – Number of Bedrooms

§ fullBaths – Number of Bathrooms

§ squareFeet – Square Feet

§ propertyType – Property Type Code(s)

§ lotAcres – Lot Acres

§ lotSqFt – Lot Square Feet

§ unitTotal – Unit Total (Residential Income Only)

§ boardID – iHomefinder MLS Board ID (Advanced Search Only)

· updateHotSheet: updates Hot Sheet info based on hotsheetID. Takes the following arguments:

o uid – company’s iHomefinder client ID number

o sid – company’s iHomefinder password

o xmlData – Hot Sheet information and MLS listings in XML format. An example xmlData parameter for an "Add listings by MLS NUMBER" type Hot Sheet can be viewed here.  An example xmlData parameter for a "Search the MLS" type Hot Sheet can be viewed here. The xmlData string must have a root element of "HotSheet" and may contain the following child elements:

§ hotsheetID (required) – iHomefinder Hot Sheet ID

§ displayName – Hot Sheet Display Name

§ header – Design Branding Header

§ showOnMasterYN – Show on Master Hot Sheet

§ description – Description Displayed on Master Hot Sheet

§ footer – Design Branding Footer

§ displayOrder – Order of Hot Sheet on Master List

§ displayText – Intro Text Displayed on Hot Sheet

Listings Info: ("Add listings by MLS NUMBER" type Hot Sheets only) Also, please note that any listings included in the Hot Sheet XML for an "updateHotSheet" request will replace any existing listings for the selected Hot Sheet.

§ listingNumber – MLS Listing Number

§ boardID – iHomefinder MLS Board ID

§ comments – Comments to be Displayed with Listing on Hot Sheet

§ displayOrder – Order Listing is Displayed on Hot Sheet

Search Profile Info: ("Search the MLS" type Hot Sheets only)

§ inclusiveYN – If value is "1", widens search with City, Zip, Sub Area, Subdivision, Neighborhood, and other geographic settings (more listings). If value is "0", narrows search with City, Zip, Sub Area, Subdivision, Neighborhood, and other geographic settings (less listings).

§ featuredOnlyYN – Limits Search to Featured Properties Only

§ cityID – iHomefinder City ID(s)

§ zip – Zip Code(s)

§ minListPrice – Minimum List Price

§ maxListPrice – Maximum List Price

§ bedrooms – Number of Bedrooms

§ fullBaths – Number of Bathrooms

§ squareFeet – Square Feet

§ propertyType – Property Type Code(s)

§ lotAcres – Lot Acres

§ lotSqFt – Lot Square Feet

§ unitTotal – Unit Total (Residential Income Only)

§ boardID – iHomefinder MLS Board ID (Advanced Search Only)

Example:

An example that consumes this web service using Cold Fusion is:

<cfinvoke webservice=" https://secure.idxre.com/ihws/HotSheetsWebService.cfc?wsdl"

method="getHotSheet"

uid="1"

sid="password"

hsid="8923"

returnVariable="_hotsheet">

</cfinvoke>

Where the clientid (uid) is 1, the password (sid) is “password”, the Hot Sheet ID (hsid) is "8923", and the method is “GetHotSheet”. This method returns XML data for a single Hot Sheet.