Website logo

Retrieve matching attribute values

Returns a list of attribute values that match the string provided

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

URL parameters

id Integer (required)

The ID of the attribute to match against

input String (required)

The string that matches the start of the values to be returned

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

Returns

Collection of <AttributeOption>

A list of attribute values

Value String or null

The value of the item as a string.

Display String or null

What should be displayed for this value (often the same).

Example XML Response (switch to JSON)

<AttributeOptions xmlns="http://api.trademe.co.nz/v1">
  <AttributeOption>
    <Value>ABC</Value>
    <Display>ABC</Display>
  </AttributeOption>
  <AttributeOption>
    <Value>ABC</Value>
    <Display>ABC</Display>
  </AttributeOption>
</AttributeOptions>

Example JSON Response (switch to XML)

[
  {
    "Value": "ABC",
    "Display": "ABC"
  },
  {
    "Value": "ABC",
    "Display": "ABC"
  }
]