To obtain a list of the items in the Business Contacts list of Contact Manager, the Property Value Estimator code uses a Web service provided by Windows SharePoint Services. The zillowsample.js file does the following:

1. A global variable is set to point to the Business Contacts list in Contact Manager.

   Copy

   var CONTACTSLISTNAME = 'Business Contacts';
   

Note:
If you downloaded this code sample before January 2008, the CONTACTSLISTNAME is set to 'Contacts'. You must update the name of the list to 'Business Contacts'.

1. The initialize function sets the Web context for this sample to Contact Manager (WebBCM).

   Copy

   var strWebContext = document.location.protocol + "//" + document.location.hostname;
       if(document.location.port != null)
       {
           strWebContext += ":" + document.location.port;
       }
       strWebContext +="/WebBCM";
   

2. The initialize function creates a WssSoap object using this Web context.

   Copy

   var g_oWssSoap = null;  
   g_oWssSoap = new WssSoap(strWebContext);
   

3. The initialize function calls the getContacts function in the zillowsample.jsx file.

   Copy

   getContacts();
   

4. The getContacts function calls the getAllListItems method for the WssSoap object from the olsharedlibv2 file. It passes the list name, the array of field names to be returned, and the function name to call on completion.

   Copy

   g_oWssSoap.getAllListItems(CONTACTSLISTNAME,
           new Array("Title", "FirstName", "HomeAddressStreet", "HomeAddressCity", "HomeAddressStateOrProvince", "HomeAddressPostalCode"),onGetContactResults);
   

5. The getAllListItems method starts the process to package a SOAP request and post it to the GetListItems method in the Lists Web service in Windows SharePoint Services 3.0.

The process used in the zillowsample.jsx file to communicate with the Zillow APIs is as follows:

1. The getZillowInformation function constructs the address to be passed to the Zillow Web service. The address is constructed by using the items retrieved from the Business Contacts list as described earlier. The items are added to the vParameters array.

   Copy

   var oCurrContact = g_vContacts[g_iSelectedContactIndex];
   
       // Parse the selected address value into params for Zillow RPCs.
       var vParameters = new Array();
       vParameters["zws-id"] = g_strZillowId;
       vParameters["address"] = oCurrContact.strAddressStreet;
       if(oCurrContact.strAddressCity && oCurrContact.strStateOrProvince)
       {
           vParameters["citystatezip"] = oCurrContact.strAddressCity + " " + oCurrContact.strStateOrProvince;
       }
       else
       {
           vParameters["citystatezip"] = oCurrContact.strHomeAddressPostalCode;
       }
   

2. The vParameters array is then passed as a parameter in a zillowRPC function call to issue an asynchronous XmlHttpRequest GET to Zillow's GetSearchResults API. For more information about the proxy required to accomplish this task, see the “Create a proxy effect” section in this article.

   Copy

   zillowRPC("GetSearchResults", vParameters, displayZillowSearchResults);
   

3. The Zillow GetSearchResults API finds a property for the specified address. The content returned contains:

   • The address for the property.

   • The Zillow Property ID (ZPID).

   • The current Zestimate.

   • The date on which the Zestimate was computed.

   • A valuation range.

   • The Zestimate ranking for the property within its ZIP code.

   • If no exact address match for a property is found, a list of closely matching properties is returned.

For the zillowRPC function to make a Web service call to Zillow, this code sample must relay the call using a server proxy. This proxy effect is achieved through a Data Form Web Part on an ASP.NET server (.aspx) page.

To use the .aspx file as a proxy, the Property Value Estimator code sample takes the following steps:

1. The getZillowInformation function calls the zillowRPC function as described earlier.

2. The zillowRPC function concatenates the proxy name with GetSearchResults, which was passed as a parameter to the function to create the URL for the HttpRequest.

   Copy

   var strFullUrl = strAction + "ZillowProxy.aspx";
   

3. The zillowRPC function then performs an HTTP GET on the .aspx page and calls the zillowCallback function.

   Copy

   g_oHttpRequest = new HttpRequest(strFullUrl, "GET", vParameters);
       g_oHttpRequest.sendRequest(zillowCallback);
   

4. The zillowCallback function finds the XML data island that was output onto the page and returns the information to a callback function.

The displayPropertyMap function does the following:

• Displays the division of the map that contains the property for which you want the value.

• Creates a Virtual Earth map object and centers it on the address for the property.

• Creates a Virtual Earth pushpin object and sets caption information for it.

• Adds the pushpin to the map.

You can view this map by scrolling down in the Page Viewer Web Part on the sample page.

The displayZillowSearchResults function is the callback function passed to the zillowCallback function in this code sample. It uses several more zillowRPC calls to collect valuation and property detail information on the property. Then it displays the map and all of the other Zillow information about the property in a Page Viewer Web Part on the sample page.