Listings: FloPlans
FloPlans are images of the layout, or 'flow', for a listing. Not all MLSs are integrated with this product. Users in an MLS with this feature enabled will have FloPlans
present in the Settings.FlexmlsProducts
attribute for their account.
Privileged API Keys Only
Special permission is required to access this service. Please contact api-support@sparkplatform.com or your API key provider to request access to this data.
Supported Roles
Role | Reads | Writes | Notes |
---|---|---|---|
IDX | Yes | No | |
Public | Yes | No | |
VOW | Yes | No | |
Portal | Yes | No | |
Private | Yes | No |
More information about roles may be found here.
Available Services
FloPlans
/<API Version>/listings/<Listing.Id>/floplans
/<API Version>/listings/incomplete/<IncompleteListing.Id>/floplans
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns FloPlans that are linked to the listing | No | |
POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
PUT | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
DELETE | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"Id": "20101127153422574618000000",
"Name": "My FloPlan",
"Images": [
{
"Uri": "http://resize.sparkplatform.com/demomls/640x480/true/20080917142739989238000000-o.png",
"Type": "all_in_one_png"
},
{
"Uri": "http://resize.sparkplatform.com/demomls/640x480/true/20080917142739989239000000-o.png",
"Type": "all_in_one_thumbnail_png"
}
]
}
]
}
}
Listing: FloPlans Description
Attribute | Data Type | Description |
---|---|---|
Id |
Character | The unique id for the FloPlan record. |
ResourceUri |
Character | The URI to the particular FloPlan record. |
Name |
Character | The name of the FloPlan. |
Images |
Array of JSON Objects | A list of image files associated with the FloPlan |
Uri |
Character | The URI the images file. These will expire after 15 minutes, and subsequent requests will generate new links. |
Type |
Character |
The type of image. One of the following:
|
Expansions
None.
API Explorer
The API Explorer does not currently support this service.