Website logo

Adds an image to the authenticated user's list of branding images

Adds an image to the authenticated user's list of branding images. These photos can be used when listing a classified. Branding images are only supported for Job listings.

At the moment, only the following image types are supported: Image types are inferred from the file name extensions and they should be one of the following types (Case is ignored): Maximum acceptable image size is 5MB.

URL: https://api.trademe.co.nz/v1/Member/{memberId}/BrandingImages.{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

memberId Integer (required)

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

POST Data

<UploadBrandingRequest>

FileName String (required) FileName
BrandingImageType Enumeration (required) BrandingImageType
Unknown 0 Unknown
Logo 1 Logo
Banner 2 Banner
Square 3 Square
FullScreenBanner 4 FullScreenBanner
Photo 5 Photo
ImageData String (required) ImageData

Returns

<UploadBrandingResponse>

Information about the uploaded branding

Success Boolean Success
Description String or null Description
BrandingImageDetails <BrandingImageDetails> or null BrandingImageDetails
Links Collection of <Link> or null Links
Href String or null Href
Rel String or null Rel
Prompt String or null Prompt
Method String or null Method

Example XML Request (switch to JSON) 

<UploadBrandingRequest xmlns="http://api.trademe.co.nz/v1">
  <FileName>ABC</FileName>
  <BrandingImageType>Unknown</BrandingImageType>
  <ImageData>ABC</ImageData>
</UploadBrandingRequest>

Example JSON Request (switch to XML) 

{
  "FileName": "ABC",
  "BrandingImageType": 0,
  "ImageData": "ABC"
}

Example XML Response (switch to JSON) 

<UploadBrandingResponse xmlns="http://api.trademe.co.nz/v1">
  <Success>false</Success>
  <Description>ABC</Description>
  <BrandingImageDetails />
  <Links>
    <Link>
      <Href>ABC</Href>
      <Rel>ABC</Rel>
      <Prompt>ABC</Prompt>
      <Method>ABC</Method>
    </Link>
    <Link>
      <Href>ABC</Href>
      <Rel>ABC</Rel>
      <Prompt>ABC</Prompt>
      <Method>ABC</Method>
    </Link>
  </Links>
</UploadBrandingResponse>

Example JSON Response (switch to XML) 

{
  "Success": false,
  "Description": "ABC",
  "BrandingImageDetails": {
  },
  "Links": [
    {
      "Href": "ABC",
      "Rel": "ABC",
      "Prompt": "ABC",
      "Method": "ABC"
    },
    {
      "Href": "ABC",
      "Rel": "ABC",
      "Prompt": "ABC",
      "Method": "ABC"
    }
  ]
}