Listings: Listing Documents

The Listing Documents service allows retrieval of URIs to listing documents for a specific listing.
  1. Supported Roles
  2. Available Services
    1. Listing Documents
    2. Individual Listing Document
  3. Response Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads? Writes?
IDX Yes No
VOW Yes No
Private Yes No
More information about roles may be found here.

Available Services

Listing Documents

URI: /<API Version>/listings/<Listing.Id>/documents

HTTP Method Description Notes
GET Returns a list of all documents for the current user
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

Example: 
{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/v1/listings/20100815153524571646000000/documents/20101125153422574618000000",
                "Id": "20101125153422574618000000",
                "Name": "Document name",
                "Uri": "http://documents.sparkplatform.com/abc.pdf"
            }
        ]
    }
}

Individual Listing Document

URI: /<API Version>/listings/<Listing.Id>/documents/

HTTP Method Description Notes
GET Returns a list of all documents for the current user
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:
  • None

GET Response

See the GET response section above for the data format.

Response Description

Attribute Data Type Description
ResourceUri Character The URI to the particular document.
Id Character The unique id for the document.
Name Character The name of the document.
Uri Character The URI to the document file.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.