Accessing FloPlan Data Using RETS
FloPlan data can be accessed using RETS in the manner listed below. The floor plan itself will be represented exclusivelyas a URL.
Any time the addition, change, or deletion of a FloPlan record impacts a listing, that listing's PhotosChangeTimestamp, ModificationTimestamp, and PhotosCount fields will be updated appropriately.
Important!
As of August 5th, 2021 FBS is releasing a change that will allow developers to retrieve FloPlan data as part of the listing data payload presented in their RETS, Spark API, and RESO Web API feeds. For a full list of options regarding FloPlan data retrieval visit our overview page.
1. Automatically Included in GetObject Response
All applicable FloPlan image URL's will be automatically appended to a listing's GetObject response when using the Location=1 parameter and represented identically to a "normal" photo record. If your data pull processes are already retrieving high resolution listing photo URLs from the Flexmls RETS server, FloPlan records will simply start flowing as part of that same process. No changes necessary.
More information on the RETS Location=1 parameter can be found here
Important!
If you attempt to retrieve a FloPlan record in binary format by omitting the Location parameter from your GetObject request or setting Location=0 you'll receive a not found error message, similar to what you'd experience when encountering a private photo. To retrieve any FloPlan records you'll need to include the Location=1 parameter in your GetObject request, which instructs the RETS server to return a hot-linkable URL to the image.