Listings: Floor Plans
The Listing Floor Plans service returns data about, and links to, floor plan images and files for a listing.
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
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": {
"Success": true,
"Results": [
{
"Id": "20210524094350000084000000",
"MediaType": "png",
"Type": "all_in_one_png",
"Caption": "123 Ivy Lane",
"Uri": "http://images.dev.fbsdata.com/demomls/20241203163349869325000000-o.png",
"Uri300": "http://images.dev.fbsdata.com/demomls/20241203163349869325000000.png",
"ModificationTimestamp": "2020-12-04T14:00:12Z",
"CurrentPrivacy": "Public"
}
]
}
}
Individual FloorPlans
/<API Version>/listings/<Listing.Id>/floorplans/<Id>
/<API Version>/listings/incomplete/<IncompleteListing.Id>/floorplans/<Id>
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the specified floorplan | 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": "20210524094350000084000000",
"MediaType": "png",
"Type": "all_in_one_png",
"Caption": "123 Ivy Lane",
"Uri": "http://images.dev.fbsdata.com/demomls/20241203163349869325000000-o.png",
"Uri300": "http://images.dev.fbsdata.com/demomls/20241203163349869325000000.png",
"ModificationTimestamp": "2020-12-04T14:00:12Z",
"CurrentPrivacy": "Public"
}
]
}
}
Listing: Floor Plans Description
| Attribute | Data Type | Description |
|---|---|---|
Id |
Character | The locally unique id for the Floor Plan record. |
MediaType |
Character | The Media Type as defined by IANA. Current supported types are: png. |
Type |
Character |
The type of file. One of the following:
|
Uri |
Character | The URI the floor plan file. |
Uri300 |
Character | The URI the thumbnail image of floor plan file. |
Caption |
Character | A brief description of the floor plan. |
ModificationTimestamp |
Timestamp | The last time the floor plan was updated. |
CurrentPrivacy |
Character | Either Public or Private. Private floor plans will only be available to FBS products, and will only be available for private roles. Use this attribute to determine the active privacy level of the floor plan. |
Expansions
None.