getItemsByIdRemoteimages

Gets available remote images for an item

Requires authentication as user

Request
get /Items/{Id}/RemoteImages
Parameters
Name In Type Default Notes
*Id path

Item Id
Type query

The image type
StartIndex query

Optional. The record index to start at. All items with a lower index will be dropped from the results.
Limit query

Optional. The maximum number of records to return
ProviderName query

Optional. The image provider to use
IncludeAllLanguages query

Optional.
Responses
Status Code Type Description Samples
200 RemoteImageResult

Operation successful. Returning a RemoteImageResult object.
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.

Definitions

RemoteImageResult

Name Type Notes
Images RemoteImageInfo[]

The images.
TotalRecordCount integer (int32)

The total record count.
Providers array

The providers.

RemoteImageInfo

Name Type Notes
ProviderName string

The name of the provider.
Url string

The URL.
ThumbnailUrl string

A url used for previewing a smaller version
Height integer (int32)

The height.
Width integer (int32)

The width.
CommunityRating number (double)

The community rating.
VoteCount integer (int32)

The vote count.
Language string

The language.
DisplayLanguage string
Type ImageType

Enum ImageType
RatingType RatingType

ImageType

Enum Values
  • Primary
  • Art
  • Backdrop
  • Banner
  • Logo
  • Thumb
  • Disc
  • Box
  • Screenshot
  • Menu
  • Chapter
  • BoxRear
  • Thumbnail
  • LogoLight
  • LogoLightColor

RatingType

Enum Values
  • Score
  • Likes