Website logo

Gets a branding image details associated with an authenticated user

Returns a branding image associated with a member. The response includes the Url to the branding image.

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

memberId Integer (required)

brandingId Integer (required)

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

Returns

<BrandingImageDetails>

A branding image with it's detail

BrandingId Integer

Branding image Id. Use this Id to add branding to your listings. This property is read-only.

FileName String or null

Branding image file name. This property is read-only. The file name may be different from the value provided during uploading the image.

FileSize Long Integer

Branding image file size in bytes. This property is read-only.

ImageUrl String or null

The location of the image. This property is read-only.

Priority Integer

The prorioty of this branding image relative to other uploaded images. This property is only applicable to agent branding and is ignored for listing specific branding. Default value is 0.

BrandingImageType Enumeration

Branding image type

Unknown 0

Default value; It should not be used

Logo 1

Branding logo (Width= 480px, Height= 200px)

Banner 2

Branding banner (Width= 758px, Height= 75px)

Square 3

Branding square (Width= 480px, Height= 480px)

Example XML Response (switch to JSON)

<BrandingImageDetails xmlns="http://api.trademe.co.nz/v1">
  <BrandingId>123</BrandingId>
  <FileName>ABC</FileName>
  <FileSize>123</FileSize>
  <ImageUrl>ABC</ImageUrl>
  <Priority>123</Priority>
  <BrandingImageType>Unknown</BrandingImageType>
</BrandingImageDetails>

Example JSON Response (switch to XML)

{
  "BrandingId": 123,
  "FileName": "ABC",
  "FileSize": 123,
  "ImageUrl": "ABC",
  "Priority": 123,
  "BrandingImageType": 0
}