Website logo

Retrieve approved property image tags by filter section

Retrieves approved property image tags grouped by filter section.

URL: https://api.trademe.co.nz/v1/SearchOptions/PropertyImageTags.{file_format}
HTTP Method: GET
Requires Authentication? No
Permission Required: Public
Supported Formats: XML, JSON
Rate Limited? No

URL parameters

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Query String parameters

filter String (optional)

The filter group to return: "must-haves", "views", "others", or "all" (default).

Returns

Collection of <PropertyImageTagFilterSection>

A collection of filter sections, each containing a list of tag options.

Filter String or null

The filter category identifier (e.g. "must-haves", "views", "others").
Options Collection of <PropertyImageTagOption> or null

The tag options belonging to this filter category.
DisplayName String or null

The display name shown to the user (e.g. "Pool", "Sea view").
Group String or null

The group identifier for this option (e.g. "pool", "sea-view").
Tags Collection of <PropertyImageTag> or null

The image tags associated with this option.
Key String or null

The tag key used for search (e.g. "pool", "ocean_view").
DisplayName String or null

The display name shown to the user (e.g. "Pool", "Ocean View").
DisplayOrder Integer or null

The display order of this option within its filter section.

Example XML Response (switch to JSON) 

<PropertyImageTagFilterSectionCollection xmlns="http://api.trademe.co.nz/v1">
  <PropertyImageTagFilterSection>
    <Filter>ABC</Filter>
    <Options>
      <PropertyImageTagOption>
        <DisplayName>ABC</DisplayName>
        <Group>ABC</Group>
        <Tags>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
        </Tags>
        <DisplayOrder>123</DisplayOrder>
      </PropertyImageTagOption>
      <PropertyImageTagOption>
        <DisplayName>ABC</DisplayName>
        <Group>ABC</Group>
        <Tags>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
        </Tags>
        <DisplayOrder>123</DisplayOrder>
      </PropertyImageTagOption>
    </Options>
  </PropertyImageTagFilterSection>
  <PropertyImageTagFilterSection>
    <Filter>ABC</Filter>
    <Options>
      <PropertyImageTagOption>
        <DisplayName>ABC</DisplayName>
        <Group>ABC</Group>
        <Tags>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
        </Tags>
        <DisplayOrder>123</DisplayOrder>
      </PropertyImageTagOption>
      <PropertyImageTagOption>
        <DisplayName>ABC</DisplayName>
        <Group>ABC</Group>
        <Tags>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
          <PropertyImageTag>
            <Key>ABC</Key>
            <DisplayName>ABC</DisplayName>
          </PropertyImageTag>
        </Tags>
        <DisplayOrder>123</DisplayOrder>
      </PropertyImageTagOption>
    </Options>
  </PropertyImageTagFilterSection>
</PropertyImageTagFilterSectionCollection>

Example JSON Response (switch to XML) 

[
  {
    "Filter": "ABC",
    "Options": [
      {
        "DisplayName": "ABC",
        "Group": "ABC",
        "Tags": [
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          },
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          }
        ],
        "DisplayOrder": 123
      },
      {
        "DisplayName": "ABC",
        "Group": "ABC",
        "Tags": [
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          },
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          }
        ],
        "DisplayOrder": 123
      }
    ]
  },
  {
    "Filter": "ABC",
    "Options": [
      {
        "DisplayName": "ABC",
        "Group": "ABC",
        "Tags": [
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          },
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          }
        ],
        "DisplayOrder": 123
      },
      {
        "DisplayName": "ABC",
        "Group": "ABC",
        "Tags": [
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          },
          {
            "Key": "ABC",
            "DisplayName": "ABC"
          }
        ],
        "DisplayOrder": 123
      }
    ]
  }
]