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
Available Services
1. FloPlans
FloPlans Description
Expansions
API Explorer

Supported Roles

Role	Reads	Writes
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": {
        "Results": [
            {
                "Id": 8956,
                "Name": "5144 Glide Dr.",
                "Images": [
                    {
                        "Uri": "https://floplan-prod.s3.amazonaws.com/3423%3A55350?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4YOJWMZT2V6ZBQP7%2F20210309%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210309T202741Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=e3d66fb85380887bcf779164ef2c869a5bfd07d7f039c5f7073d39ed2dd6a54b",
                        "Type": "all_in_one_pdf"
                    },
                    {
                        "Uri": "https://floplan-prod.s3.amazonaws.com/3423%3A55346?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4YOJWMZT2V6ZBQP7%2F20210309%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210309T202741Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=4ecedbe2d86dcef7c0133982ffb2f2a6839d8092a82434c49717e9e1c3503c38",
                        "Type": "all_in_one_thumbnail_png"
                    },
                    {
                        "Uri": "https://floplan-prod.s3.amazonaws.com/3423%3A55333?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA4YOJWMZT2V6ZBQP7%2F20210309%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20210309T202741Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=c2bba05849695da914e6d94f53a4479fd0f897051e35905a55a5ab77d196af74",
                        "Type": "all_in_one_png"
                    }
                ]
            }
        ],
        "Success": true
    }
}

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: all_in_one_png: The large all-floors-in-one image. all_in_one_thumbnail_png: The thumbnail of the all-floors-in-one image. all_in_one_pdf: The PDF of the all-floors-in-one image.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.