Developer Documentation
Platform Overview
Authentication
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 Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Listing Updates 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: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads 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: 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: 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 Messages 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 Portals Portal Groups Portal Groups: Current Portal Groups: Tags Portals: Listing Categories Portals: Metadata Preferences Properties Properties: Clusters Properties Meta: Standard Fields 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
API Explorer
Supporting Documentation
Examples
RESO Web API
RETS
Terms of Use

Photos: Metadata

The Photos Metadata service describes the defined Tags and Privacy values for listing photos.

 
  1. Supported Roles
  2. Available Services
    1. Listing Photos Metadata
  3. Photos Metadata Description
  4. Expansions
  5. API Explorer
 

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No

More information about roles may be found here.

 

Available Services

Listing Photos Metadata

/<API Version>/listings/photos/meta
/<API Version>/listings/incomplete/photos/meta

HTTP Method Description Conditional Notes
GET Retrieves the meta data for listing photos No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:

 

GET Response

{
  "D": {
    "Results": [{
      "Privacy": {
        "Default": "Private",
        "Options": ["Public", "Private", "Automatic"],
        "OffMarketStandardStatuses": ["Closed"]
      },
      "Tags": {
        "Room": ["Bathroom", "Bedroom", "Dining", "Fitness", "Kitchen", "Laundry", "Living"]
      }
    }],
    "Success": true
  }
}

 
 

Listing Photos Metadata Description

Attribute Data Type Description
Privacy JSON Object Meta data for the Privacy attribute on listing photos.
Default Character The default Privacy setting for photos.
Options Character List The Privacy values users can manually choose when saving or updating a listing photo.
OffMarketStandardStatuses Character List Photos with a Privacy of "Automatic" will have their CurrentPrivacy updated to "Private" when the associated listing changes to one of these standard statuses.
Tags JSON Object The available tags for listing photos. Note that all lists of tags are in groups, such as Rooms. When filtering selections, tag values will be reference by <Group>.<Tag>, such as Room.Living.
 

Expansions

None.

 

API Explorer

Interact with this service using the API Explorer.