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:
  • None

GET Response

{
  "D": {
    "Results": [{
      "Privacy": {
        "Default": "Private",
        "Options": ["Public", "Private"]
      },
      "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.
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.