Retrieves your property agent report
Retrieves the Property Agent report for the authenticated user.
URL: | https://api.trademe.co.nz/v1/mytrademe/propertyagentreport/{filter}.{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
filter | String (required) |
The range for the report.
|
||||||||
---|---|---|---|---|---|---|---|---|---|---|
file_format | Enumeration (required) | The format of the response. | ||||||||
|
Returns
<PropertyAgentReport>
The Property Agent report data.
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 <PropertyAgentReportLine> or null |
A list of the results in the current page. |
||||||||||||||||||||||||||||||||||||||||||||||
|