Website logo

Modify search suggestion settings

Modifies the user's search suggestion settings.

URL: https://api.trademe.co.nz/v1/Search/Suggestions.{file_format}
HTTP Method: POST
Requires Authentication? Yes
Permission Required: MyTradeMeWrite: Maintain your watchlist, answer questions and post comments.
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

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

POST Data

<SearchSuggestionSettingsRequest>

RecentSearchesEnabled Boolean (required)

Whether or not to enable recording of recent searches against the user's profile. Setting this to false clears the user's recent searches and prevents search queries from being recorded.

Returns

<SearchSuggestionsResponse>

Details on whether the operation succeeded.

Success Boolean

Indicates whether the operation was successful.
Description String or null

The description of the error, if the operation failed.

Example XML Request (switch to JSON) 

<SearchSuggestionSettingsRequest xmlns="http://api.trademe.co.nz/v1">
  <RecentSearchesEnabled>false</RecentSearchesEnabled>
</SearchSuggestionSettingsRequest>

Example JSON Request (switch to XML) 

{
  "RecentSearchesEnabled": false
}

Example XML Response (switch to JSON) 

<SearchSuggestionsResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
</SearchSuggestionsResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "Description": "ABC"
}