Retrieve your favourite categories
Retrieves the list of favourite categories for the currently authenticated user.
URL: | https://api.trademe.co.nz/v1/Favourites/Categories.{file_format} |
---|---|
HTTP Method: | GET |
Requires Authentication? | Yes |
Permission Required: | MyTradeMeRead: Read your membership & listing data. |
Supported Formats: | XML, JSON |
Rate Limited? | Yes |
URL parameters
file_format | Enumeration (required) | The format of the response. | ||||
---|---|---|---|---|---|---|
|
Query String parameters
page | Integer (optional) |
The page number of the set of results to return, starting from 1. Defaults to 1. |
---|---|---|
rows | Integer (optional) |
The number of results per page; also the maximum number of results to return. Defaults to all favourites. |
Returns
<SavedCategories>
A list of favourite categories.
TotalCount | Integer |
The total number of results in the collection. Can be larger than the number of returned results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Page | Integer |
The index of the current page of results (starts at 1). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PageSize | Integer |
The number of results in the current page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
List | Collection of <SavedCategory> or null |
A list of the results in the current page. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|