Listings: Document Uploads

This service allows the client upload a document 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.

Once uploaded, these are retreived from the Listing Documents resource.

Supported Roles
Available Services
1. Document Uploads
Response Description
Expansions

Supported Roles

Role	Reads	Writes
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

Document Uploads

URI: Supplied by the Uri attribute in the Listing: Tickets response.

HTTP Method	Description	Notes
POST	Uploads a new document	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.
`Name`	Yes
`Token`	Yes
`File`	Yes	Document file to upload
`RedirectTo`	No	URL to send the user back to on successful upload. Optional, JSON response with success message and Id will display by default (See below).
`confidentiality`	Yes	Can be: `public` shows the document in all cases. `datashare` shows the document for private and datashare role. `private` shows the document for the private role. `hasedit` shows the document to only agents that can edit listing.

POST Response (Sample)

On success, when RedirectTo is present, the response redirects the user to the URI, otherwise the response contains the Id of the new document.

{
    "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 document.	All	Private

Expansions

None.