GET api/cmppnetworklogo/{id}?width={width}&height={height}&crop={crop}&hexColor={hexColor}&placeholderForMissingLogo={placeholderForMissingLogo}

Gets a logo image for a network if it exists with ability to specify new dimensions. If network does not have a logo, an optional placeholder image can be returned or a 404 status code.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Network identifier

integer

Required

width

Optional image width (in pixels)

integer

None.

height

Optional image height (in pixels)

integer

None.

crop

Optional paramter that indicates how to handle resizing the image if the new dimensions are not proportional to the old dimensions. When cropping is enabled, the image will be cropped as needed to keep the image proporitioanl to the original. When cropping is disabled (default behavior), the image will be scaled to the new size but with padding added as needed accommodate the new dimensions

boolean

Default value is False

hexColor

When crop is not used, the image may be padded in order to scale to requested size. The hex color controls the color of the padded margins.

string

None.

placeholderForMissingLogo

Optional parameter used to indicate if placeholder image should be returned if the network does not have an image loaded.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The logo associated with the network

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.