headPersonsByNameImagesByTypeByIndex

Requires authentication as user

Request
head /Persons/{Name}/Images/{Type}/{Index}
Parameters
Name In Type Default Notes
*Name path

Item name
MaxWidth query

The maximum image width to return.
MaxHeight query

The maximum image height to return.
Width query

The fixed image width to return.
Height query

The fixed image height to return.
Quality query

Optional quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
Tag query

Optional. Supply the cache tag from the item object to receive strong caching headers.
CropWhitespace query

Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.
EnableImageEnhancers query

Enable or disable image enhancers such as cover art.
Format query

Determines the output foramt of the image - original,gif,jpg,png
BackgroundColor query

Optional. Apply a background color for transparent images.
ForegroundLayer query

Optional. Apply a foreground layer on top of the image.
AutoOrient query

Set to true to force normalization of orientation in the event the renderer does not support it.
KeepAnimation query

Set to true to retain image animation (when supported).
*Index path

Image Index
*Type path

Image Type
Responses
Status Code Type Description Samples
200

Operation successful. Response content unknown.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.