Website logo

Retrieve reviews for a listing

Retrieves reviews for a listing. Currently only applicable to services listings.

URL: https://api.trademe.co.nz/v1/listings/{listingId}/reviews.{file_format}
HTTP Method: GET
Requires Authentication? Yes
Permission Required: None
Supported Formats: XML, JSON
Rate Limited? Yes

URL parameters

listingId Integer (required)

The ID of the listing to retrieve reviews for.
file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

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 20.

Returns

<ListingReviewCollection>

Information on whether the operation was successful.

TotalCount Integer TotalCount
Page Integer Page
PageSize Integer PageSize
List Collection of <ListingReview> or null InnerList
ReviewId Integer ReviewId
Date DateTime Date
Positive Boolean Positive
ReviewText String or null ReviewText
Member <Member> or null Member
MemberId Integer MemberId
Nickname String or null Nickname
DateAddressVerified DateTime DateAddressVerified
DateJoined DateTime DateJoined
UniqueNegative Integer UniqueNegative
UniquePositive Integer UniquePositive
FeedbackCount Integer FeedbackCount
IsAddressVerified Boolean IsAddressVerified
IsDealer Boolean IsDealer
IsAuthenticated Boolean IsAuthenticated
Response String or null Response
ResponseDate DateTime ResponseDate

Example XML Response (switch to JSON) 

<ListingReviewCollection xmlns="http://api.trademe.co.nz/v1">
  <TotalCount>123</TotalCount>
  <Page>123</Page>
  <PageSize>123</PageSize>
  <List>
    <ListingReview>
      <ReviewId>123</ReviewId>
      <Date>2018-01-01T00:00:00Z</Date>
      <Positive>false</Positive>
      <ReviewText>ABC</ReviewText>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
      </Member>
      <Response>ABC</Response>
      <ResponseDate>2018-01-01T00:00:00Z</ResponseDate>
    </ListingReview>
    <ListingReview>
      <ReviewId>123</ReviewId>
      <Date>2018-01-01T00:00:00Z</Date>
      <Positive>false</Positive>
      <ReviewText>ABC</ReviewText>
      <Member>
        <MemberId>123</MemberId>
        <Nickname>ABC</Nickname>
        <DateAddressVerified>2018-01-01T00:00:00Z</DateAddressVerified>
        <DateJoined>2018-01-01T00:00:00Z</DateJoined>
        <UniqueNegative>123</UniqueNegative>
        <UniquePositive>123</UniquePositive>
        <FeedbackCount>123</FeedbackCount>
        <IsAddressVerified>false</IsAddressVerified>
        <IsDealer>false</IsDealer>
        <IsAuthenticated>false</IsAuthenticated>
      </Member>
      <Response>ABC</Response>
      <ResponseDate>2018-01-01T00:00:00Z</ResponseDate>
    </ListingReview>
  </List>
</ListingReviewCollection>

Example JSON Response (switch to XML) 

{
  "TotalCount": 123,
  "Page": 123,
  "PageSize": 123,
  "List": [
    {
      "ReviewId": 123,
      "Date": "\/Date(1514764800)\/",
      "Positive": false,
      "ReviewText": "ABC",
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false
      },
      "Response": "ABC",
      "ResponseDate": "\/Date(1514764800)\/"
    },
    {
      "ReviewId": 123,
      "Date": "\/Date(1514764800)\/",
      "Positive": false,
      "ReviewText": "ABC",
      "Member": {
        "MemberId": 123,
        "Nickname": "ABC",
        "DateAddressVerified": "\/Date(1514764800)\/",
        "DateJoined": "\/Date(1514764800)\/",
        "UniqueNegative": 123,
        "UniquePositive": 123,
        "FeedbackCount": 123,
        "IsAddressVerified": false,
        "IsDealer": false,
        "IsAuthenticated": false
      },
      "Response": "ABC",
      "ResponseDate": "\/Date(1514764800)\/"
    }
  ]
}