Listings: Floor Plans

The Listing Floor Plans service returns data about, and links to, floor plan images and files for a listing. A single floor plan may have multiple files associated with it, and these files are grouped by the GroupId attribute.

Supported Roles
Available Services
1. Floor Plans
Floor Plans Description
Expansions

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

FloorPlans

`/<API Version>/listings/<Listing.Id>/floorplans`
`/<API Version>/listings/incomplete/<IncompleteListing.Id>/floorplans`

HTTP Method	Description	Conditional	Notes
GET	Returns floor plans 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": "20210524094350000084000000",
                  "MediaKey": "2355.RESOID.20201203215805619564000000",
                  "MediaType": "png",
                  "GroupId": "5447",
                  "Type": "all_in_one_thumbnail_png",
                  "Caption": "123 Ivy Lane",
                  "Uri": "https://api.floplan.io/api/images/d2f8ae12-cda4-4f10-bc55-73ac5a15e09a",
                  "ModificationTimestamp": "2020-12-04T14:00:12Z"
          }, {
                  "Id": "20210524094350000085000000",
                  "MediaKey": "2347.RESOID.20201203215805619564000000",
                  "MediaType": "png",
                  "GroupId": "5447",
                  "Type": "all_in_one_png",
                  "Caption": "123 Ivy Lane",
                  "Uri": "https://api.floplan.io/api/images/8d62740e-8579-4b8a-a918-34842b855cc3",
                  "ModificationTimestamp": "2020-12-04T14:00:12Z"
          }
        ],
        "Success": true
    }
}

Listing: Floor Plans Description

Attribute	Data Type	Description
`Id`	Character	The locally unique id for the Floor Plan record.
`MediaKey`	Character	The ID for this floor plan from the remote system.
`MediaType`	Character	The Media Type as defined by IANA. Current types are: `png`, `pdf`.
`GroupId`	Character	A single floor plan may have multiple file types associated with it. The `GroupId` groups these records as a single floor plan entity.
`Type`	Character	The type of file. 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.
`Uri`	Character	The URI the floor plan file.
`Caption`	Character	A brief description of the floor plan.
`ModificationTimestamp`	Timestamp	The last time the floor plan was updated.

Expansions

None.