Floor Plans: Metadata
The Floor Plans Metadata service describes the Privacy values for listing floor plans.
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
Listing Floor Plans Metadata
/<API Version>/listings/floorplans/meta
/<API Version>/listings/incomplete/floorplans/meta
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves the meta data for listing floor plans | 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": [{
"Privacy": {
"Default": "Private",
"Options": ["Public", "Private", "Automatic"],
"OffMarketStandardStatuses": ["Closed"]
}
}],
"Success": true
}
}
Listing Floor Plans Metadata Description
| Attribute | Data Type | Description |
|---|---|---|
Privacy |
JSON Object | Meta data for the Privacy attribute on listing floor plans. |
Default |
Character | The default Privacy setting for photos. |
Options |
Character List | The Privacy values users can manually choose when saving or updating a listing floorplan. |
OffMarketStandardStatuses |
Character List | Floor plans with a Privacy of "Automatic" will have their CurrentPrivacy updated to "Private" when the associated listing changes to one of these standard statuses. |
Expansions
None.