Listings: Floor Plan Uploads
This service allows the client to upload a floorplan using a listing paired with the Tickets resource for listings or incomplete listings, this service provides a simple interface to submit forms directly to the API from a web browser.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | No | No | |
| Public | No | No | |
| VOW | No | No | |
| Portal | No | No | |
| Private | No | Yes |
More information about roles may be found here.
Available Services
Floor Plan Uploads
URI: Supplied by the Uri attribute in the Listing: Tickets response.
| HTTP Method | Description | Notes |
|---|---|---|
| POST | Uploads a new floor plan or updates an existing floor plan if the Id parameter is supplied | Requires HTTP form based post submissions instead of the standard API JSON body. |
| GET,PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
POST Request
Parameters:
| Form Parameter | Required | Description |
|---|---|---|
Token |
Yes | The upload token granted from the Listing: Tickets service. |
Id |
No | The id of the floor plan being replaced if this is a replacement. Blank if this is a creation. |
File |
Yes | Floor plan file to upload |
Caption |
No | A caption for the floor plan, up to 1000 characters. |
Privacy |
No | A privacy setting as defined in the floorplans metadata resource. If empty, defaults to Public. |
{
"D": {
"Success": true,
"Results": [
{
"Id": "20120117194139638109000000"
}
]
}
}Response Description
| Attribute | Description | Returned for Which User Type(s) | Returned for Which API Key Role(s) |
|---|---|---|---|
Id |
ID of the uploaded or replaced floor plan. | All | Private |
Expansions
None.