Website logo

Retrieve complaint subjects

Retrieves a list of possible complaint subjects. This is used in conjunction with the send a complaint API.

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

URL parameters

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

Returns

Collection of <ComplaintSubject>

A list of subjects that can be used when making a complaint.

SubjectId Integer

The ID of the complaint subject.

Description String or null

A description of the complaint subject, suitable for displaying to a user.

Examples

https://api.trademe.co.nz/v1/ComplaintSubjects.xml

Example XML Response (switch to JSON)

<ComplaintSubjectCollection xmlns="http://api.trademe.co.nz/v1">
  <ComplaintSubject>
    <SubjectId>123</SubjectId>
    <Description>ABC</Description>
  </ComplaintSubject>
  <ComplaintSubject>
    <SubjectId>123</SubjectId>
    <Description>ABC</Description>
  </ComplaintSubject>
</ComplaintSubjectCollection>

Example JSON Response (switch to XML)

[
  {
    "SubjectId": 123,
    "Description": "ABC"
  },
  {
    "SubjectId": 123,
    "Description": "ABC"
  }
]