Listing Photos

This documentation has moved to the Spark Platform website. Please click here to view.

The Listing Photos service allows data about listing photos for a specific listing to be retrieved. URIs to a variety of photo sizes are returned rather than image files.

  1. Applicable API Key Roles
  2. Authentication
  3. Available Services
    1. Get info for photos on a listing
    2. Get info for a single photo on a listing
  4. Listing Photo 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 photos on a listing

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

XX is a listing ID, such as 20100912153422758914000000 .

HTTP Method Description Notes
GET Gets info about photos 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 Photo Response Format.

Get info for a single photo on a listing

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

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

HTTP Method Description Notes
GET Gets info about an individual photo 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 Photo Response Format.

Listing Photo Response Format

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

{
    "D": {
        "Success": true,
        "Results": [
            {
                "ResourceUri": "/vX/listings/20060412165917817933000000/photos/20080917142739989238000000",
                "Id": "20080917142739989238000000",
                "Name": "Listing Photo",
                "Caption": "",
                "UriThumb": "http:\/\/photos.flexmls.com\/demomls\/20080917142739989238000000-t.jpg",
                "Uri300": "http:\/\/photos.com\/demomls\/20080917142739989238000000.jpg",
                "Uri640": "http:\/\/resize.flexmls.com\/demomls\/640x480\/true\/20080917142739989238000000-o.jpg",
                "Uri800": "http:\/\/resize.flexmls.com\/demomls\/800x600\/true\/20080917142739989238000000-o.jpg",
                "Uri1024": "http:\/\/resize.flexmls.com\/demomls\/1024x768\/true\/20080917142739989238000000-o.jpg",
                "Uri1280": "http:\/\/resize.flexmls.com\/demomls\/1280x1024\/true\/20080917142739989238000000-o.jpg",
                "UriLarge": "http:\/\/photos.flexmls.com\/demomls\/20080917142739989238000000-o.jpg",
                "Primary": true
            }
        ]
    }
}

Comments on this entry are closed.