Developer Documentation
Platform Overview
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Required Documents Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Hot Sheet Parameters Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Required Documents Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Groups News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Notifications Open Houses Overlays Overlays: Geometries Portals Portals: Listing Categories Portals: Metadata Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Terms of Use

HOW TO: Retrieve photo and document names

When photos or documents are uploaded to flexmls by listing agents, users are given the ability to enter a publicly displayed name along with the attachment. These additional names can be used to help describe a picture by giving it context or explaining the location where the photo was taken.

Through the flexmls RETS server, these names are provided alongside the photos and documents that are retrieved. When a GetObject request is made, a "Content-Description" header is included (along with the other expected headers). The value of this header contains the name provided for that object.

For example, the following represents an example response from our RETS server:

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Cache-Control: private
RETS-Version: RETS/1.7.2
MIME-Version: 1.0
Content-Type: multipart/parallel; boundary="FLEXlwyQfTEG86CODzQzeRn8JNCpPMTCcbf4Vanu1FC8WeZe4BQzIZ"
Date: Tue, 17 Sep 2013 21:22:23 GMT
Connection: close
(image data) 
Content-Type: image/jpeg
Content-ID: 135099
Object-ID: 1
Content-Description: Front Exterior
Preferred: 1

(image data)
Content-Type: image/jpeg
Content-ID: 135099
Object-ID: 2
Content-Description: Expansive View of Rear of House

(image data)

The above response shows 2 photos returned by the GetObject request each with a "Content-Description" header describing the object.

You’ll need to consult the documentation for the tool you’re using to determine the best way to extract this information. For users of libRETS, GetDescription() can be used to retrieve that value. For users of PHRETS, the "Content-Description" key is available for each object.