Listing Documents

The Listing Documents service allows retrieval of URIs to listing documents for a specific listing.

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Get info for documents on a listing
    2. Get info for a single document on a listing
  4. Listing Document Response Format

Applicable API Key Roles

This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. Listing data is restricted based on the API key and user’s current permission level. For example, IDX API keys will only have access to IDX listings. More information about roles may be found here.

Authentication

Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Available Services

Get info for documents on a listing

URI: /<API Version>/listings/XX/documents

XX is a listing ID, such as 20100912153422758914000000 .

HTTP Method Description Notes
GET Gets info about documents for a specified listing. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response

This returns the Listing Document Response Format.

Get info for a single document on a listing

URI: /<API Version>/listings/XX/documents/YY

XX is a listing ID, such as 20100912153422758914000000 .
YY is a document ID, such as 20101222111526876245000000 .

HTTP Method Description Notes
GET Gets info about an individual document for a specified listing. See parameters below
POST,PUT,DELETE Returns HTTP 405 (Method Not Allowed) Not implemented

GET Request

Parameters:

  • None

GET Response

This returns the Listing Document Response Format.

Listing Document Response Format

The response may include multiple documents. This example illustrates the response format for a listing with a single document.

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

Comments on this entry are closed.