Knowledge Base/Other Ways to Access RPR/API and Deep Linking

Deep Linking

Brett Nordby
posted this on November 10, 2010 08:31 pm

Summary:  Deep Linking is a concept that allows an MLS to link directly to a "deep" interior page of RPR.  An example would be a link on an MLS listing input form that takes the user to an RPR public records page so the agent can grab useful information for the listing.  Another would be to link to an RPR report generation page for the property.  

This deep linking technology can be used with Cobranding (an RPR feature that lets customize RPR with your own logo) and with Single Sign-On or SSO (which allows MLS users to login to RPR seamlessly, without entering their RPR credentials, when they are already authenticated with the MLS).

Implementing Deep Linking is easy, but does require a developer.  The basic steps are as follows:

  1. Decide which RPR pages you would like to link to, and where you want to place those links on your website.
  2. Construct the links you need using the technical guidance below.
  3. Add the links to the website code, in the appropriate places.
  4. Make the link parameters dynamic, so the links use the specific geographical location or address when pointing to RPR.
  5. Test!


Technical Guidance: Constructing the Deep Link

  1. Start with the base link:  http://www.narrpr.com/find.aspx?
  2. Determine if you have an RPR cobrand.  If so, you will need to add cbcode=<yourcode> to the querystring.
  3. Determine if you have Single Sign-On (SSO) in place with RPP.  If so, add ssocode=<yourcode> to the querystring.
  4. Add additional parameters to the query string, to return the specific data you're looking for:
    1. Search Results:
      1. SearchType
        • 1 = All Properties search results
        • 2 = For Sale search results
        • 3 = Neighborhood search results
      2. ResultType
        • 1 = List View
        • 2 = Map View
      3. Query
        • City, State and/or Zip
        • Neighborhood, City, State and/or Zip
        • Streetname, City, State and/or Zip
        • Street Number Range, StreetName, City, State and/or Zip
      4. Examples:
        1. http://www.narrpr.com/find.aspx?SearchType=1&Query=1-5 Live Oak, Irvine, CA 92604
    2. Property/Listing Details:
      1. DetailsTab (representing the tab number of the RPR property details page)
        • 1 = Summary
        • 2 = History
        • 3 = Charts & Graphs
        • 4 = Refined Value
        • 5 = Comp Analysis
      2. Query
        • City, State and/or Zip
        • Neighborhood, City, State and/or Zip
        • Streetname, City, State and/or Zip
        • Street Number Range, StreetName, City, State and/or Zip
      3. APN
        • Formatted APN number (i.e. 451-683-01)
        • You must specify a city, state and/or zip in the Query parameter, or specify a StateCountyFIPS in the FIPS parameter, to use APN search.
      4. OrgID
        1. Your RPR implementation specialist can provide you with your OrgID.  It typically matches your cbcode/ssocode.
      5. ListingID
        1. The Listing ID of the listing in question.
        2. If you also specified an area in the Query parameter, results will be filtered using both criteria.
      6. Examples:
    3. Reports:
      1. ReportType
        • 1 = Property Report
        • 2 = Market Activity Report
        • 3 = Seller's Report
        • 4 = Mini Property Report
        • 5 = Neighborhood Report
      2. Query
        • City, State and/or Zip
        • Neighborhood, City, State and/or Zip
        • Streetname, City, State and/or Zip
        • Street Number Range, Streetname, City, State and/or Zip
      3. Examples:
        1. Property Report:  http://www.narrpr.com/find.aspx?ReportType=1&Query=1 Live Oak, Irvine, CA
        2. Seller's Report:  http://www.narrpr.com/find.aspx?ReportType=2&Query=1 Live Oak, Irvine, CA
        3. Market Activity Report:  http://www.narrpr.com/find.aspx?ReportType=3&Query=1 Live Oak, Irvine, CA

Tips

  • If you do an APN search, you must also specify a location -- either an area in the Query parameter, or a StateCountyFIPS code in the FIPS parameter.
  • It's best to URLencode the querystring you generate, even though most modern web browsers do this for you automatically.
  • If you search by property address, it's best to use an address that has been passed through an address standardizer.  If that isn't available, make sure the address is as accurate as possible and that it is formatted as closely as possible to USPS standards.
  • If the user is not signed into RPR, they will be prompted to do so (unless SSO is configured), and will then be taken to the requested page.
  • You can open the RPR deep link in the user's existing window, in an entirely new window, or even in an iframe (this can be handled by your developers).
  • An example with cobrand and SSO support would be:
    http://www.narrpr.com/find.aspx?&SearchType=1&Query=Irvine, CA 92604&cbcode=<yourcode>&ssocode=<yourcode> (this link will not work without customizing cbcode and ssocode)

 Known Issues

  • When a property address or area is specified but not uniquely identified by RPR, we will display a "Did you mean" dialog box where the user can choose from among several options.  This is a feature, and it occurs for legitimate reasons (such as when the Query parameter only include a zip code, but that zip code matches not only the real zip but also a number of other listing IDs across the country).

Questions?

Please contact your account representative for assistance with implementing deep linking.