Accessing FloPlan Data Using Spark
FloPlan data can be accessed using Spark API in one of the three manners listed below. The floor plan itself will be represented as a URL, similar to how Spark manages listing photos.
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. Additionally, there is a new FloorPlansChangeTimestamp field that indicates the DateTime of the last update to a listing's floor plans data.
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 Photos Expansion and Service
All applicable FloPlan records will be automatically appended to the end of the photo roll and represented near identically to a "normal" photo record. If your data pull processes are already retrieving photos from the Spark API, all applicable FloPlan records will simply start flowing as part of that same process. No changes necessary. Each of these FloPlan records will have a Caption of "Floor Plan".
For more information on retrieving Photo data via the Spark API see the documentation links below:
2. /listings/<Listing.Id>/floplans Service
See the service documentation below for details.
3. /listings/<Listing.Id>/floorplans Service
See the service documentation below for details. This service differs from the /listings/<Listing.Id>/floplans service in that it can potentially contain floor plans from other sources. It is not technically limited to just FloPlan data.