Returns images and trailers associated with television:
A single request can return all of these kinds of images and any number of them.
This request returns a large amount of data. To speed data transmission, request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.
POST /v9/richmediaservice.asmx HTTP/1.1
Host: api.rovicorp.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthHeader xmlns="http://api.rovicorp.com/v9/common/types">
<UserName>string</UserName>
<Password>string</Password>
</AuthHeader>
</soap12:Header>
<soap12:Body>
<GetMedia xmlns="http://api.rovicorp.com/v9/richMediaService">
<request>
<ImageItems>
<ImageItem />
<ImageItem />
</ImageItems>
<Image>
<ImageUrl>string</ImageUrl>
<ImageUseType>Logo or HeroImage or Thumbnail</ImageUseType>
<ImageId>int</ImageId>
<ImageTitle>string</ImageTitle>
<ImageCaption>string</ImageCaption>
<ObjectId>string</ObjectId>
<ObjectType>Program or Credit or Source</ObjectType>
<ObjectName>string</ObjectName>
<Relevancy>boolean</Relevancy>
<ImageCredit>string</ImageCredit>
<ImageCreditDisplay>boolean</ImageCreditDisplay>
<ImageCastWeight>float</ImageCastWeight>
<ImageZoomLevel>1 or 2 or 3 or 4 or 5</ImageZoomLevel>
<ImageHeadcount>int</ImageHeadcount>
<ImageType>string</ImageType>
<ImageFormat>jpg or png or gif or bmp</ImageFormat>
<ImageHorizontalResolution>int</ImageHorizontalResolution>
<ImageVerticalResolution>int</ImageVerticalResolution>
<ImageMaintainAspectFlag>boolean</ImageMaintainAspectFlag>
<ImageExpiryDateTime>dateTime</ImageExpiryDateTime>
<LastUpdate>dateTime</LastUpdate>
<ImageFormatId>int</ImageFormatId>
<Orientation>string</Orientation>
<AspectRatio>string</AspectRatio>
<ImageOwner>string</ImageOwner>
<ParentImageId>int</ParentImageId>
<ProgramTitle>string</ProgramTitle>
<MaxImageScale>float</MaxImageScale>
</Image>
<Page>
<PageSize>int</PageSize>
<StartIndex>int</StartIndex>
<TotalRows>int</TotalRows>
<SortByColumn>
<int>int</int>
<int>int</int>
</SortByColumn>
</Page>
<IncludeExpiredMediaOnly>boolean</IncludeExpiredMediaOnly>
<Locale>string</Locale>
<ImageTypes>
<string>string</string>
<string>string</string>
</ImageTypes>
<ImageFormatIds>
<int>int</int>
<int>int</int>
</ImageFormatIds>
</request>
</GetMedia>
</soap12:Body>
</soap12:Envelope>
Get images of Mark Harmon and Pauley Perrette together.
Request images of just Mark Harmon.
Since I like one image, request all of the available sizes and formats of that image so I can choose the one I want.
Request group images of the characters in the Simpsons in JPG format.
Request station logos for ESPN.
Name | Required | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ImageItems | Yes | ImageItem [ ] | Type of items you want to return and the IDs of the items. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Locale | Yes | String | Language and country code of the television service. This is a case-insensitive combination of the ISO 639 language code, a hyphen character, and the ISO 3166 country code, as described in RFC 1766. Valid locales include:
[1] Includes Wales, Scotland, and Northern Ireland. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ClientBatchId | No | String | A trace code to be returned in the response header so you can track a batch of requests. The code can be up to 255 characters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludeExpiredMediaOnly | No | Boolean | Whether to return only images that are past their expiration date: true or false. Default is false: images past their expiration date are not returned. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Image | No | Image | Specifies properties of the images to be returned. You can filter the returned images by one or more of the following properties:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImageFormatIds | No | Integer [ ] | Format IDs of images to be returned. This image filter is added to any filters specified in the Image parameter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ImageTypes | No | String [ ] | Image types of images to be returned. This filter is added to the filters specified in the Image parameter. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Page | No | DataPage | Settings that return images one pageful at a time and determine the sequence of the response. |
Response | Type | Description |
---|---|---|
Build | String | Software build version of the API. |
ClientBatchId | String | The batch ID you supplied in the request. |
EndTimestamp | DateTime | Time the server finished processing the request. |
Errors | Error [ ] | Processing errors or warnings. |
RequestId | String GUID | A generated value that identifies the request and response. |
Status | Status | Processing status, indicating whether the request was successfully processed. |
TimeStamp | DateTime | Time the server started processing the request. |
Name | Type | Description |
---|---|---|
Images | Image [ ] | The requested images. |
VideoClips | VideoClip [ ] | The requested video clips. |
Page | DataPage | The number of images available, and echoes of the values specified in the Page parameter. |
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetMediaResponse xmlns="http://api.rovicorp.com/v9/richMediaService">
<GetMediaResult>
<Images>
<Image>
<ImageUrl>string</ImageUrl>
<ImageUseType>Logo or HeroImage or Thumbnail</ImageUseType>
<ImageId>int</ImageId>
<ImageTitle>string</ImageTitle>
<ImageCaption>string</ImageCaption>
<ObjectId>string</ObjectId>
<ObjectType>Program or Credit or Source</ObjectType>
<ObjectName>string</ObjectName>
<Relevancy>boolean</Relevancy>
<ImageCredit>string</ImageCredit>
<ImageCreditDisplay>boolean</ImageCreditDisplay>
<ImageCastWeight>float</ImageCastWeight>
<ImageZoomLevel>1 or 2 or 3 or 4 or 5</ImageZoomLevel>
<ImageHeadcount>int</ImageHeadcount>
<ImageType>string</ImageType>
<ImageFormat>jpg or png or gif or bmp</ImageFormat>
<ImageHorizontalResolution>int</ImageHorizontalResolution>
<ImageVerticalResolution>int</ImageVerticalResolution>
<ImageMaintainAspectFlag>boolean</ImageMaintainAspectFlag>
<ImageExpiryDateTime>dateTime</ImageExpiryDateTime>
<LastUpdate>dateTime</LastUpdate>
<ImageFormatId>int</ImageFormatId>
<Orientation>string</Orientation>
<AspectRatio>string</AspectRatio>
<ImageOwner>string</ImageOwner>
<ParentImageId>int</ParentImageId>
<ProgramTitle>string</ProgramTitle>
<MaxImageScale>float</MaxImageScale>
</Image>
<Image>
<ImageUrl>string</ImageUrl>
<ImageUseType>Logo or HeroImage or Thumbnail</ImageUseType>
<ImageId>int</ImageId>
<ImageTitle>string</ImageTitle>
<ImageCaption>string</ImageCaption>
<ObjectId>string</ObjectId>
<ObjectType>Program or Credit or Source</ObjectType>
<ObjectName>string</ObjectName>
<Relevancy>boolean</Relevancy>
<ImageCredit>string</ImageCredit>
<ImageCreditDisplay>boolean</ImageCreditDisplay>
<ImageCastWeight>float</ImageCastWeight>
<ImageZoomLevel>1 or 2 or 3 or 4 or 5</ImageZoomLevel>
<ImageHeadcount>int</ImageHeadcount>
<ImageType>string</ImageType>
<ImageFormat>jpg or png or gif or bmp</ImageFormat>
<ImageHorizontalResolution>int</ImageHorizontalResolution>
<ImageVerticalResolution>int</ImageVerticalResolution>
<ImageMaintainAspectFlag>boolean</ImageMaintainAspectFlag>
<ImageExpiryDateTime>dateTime</ImageExpiryDateTime>
<LastUpdate>dateTime</LastUpdate>
<ImageFormatId>int</ImageFormatId>
<Orientation>string</Orientation>
<AspectRatio>string</AspectRatio>
<ImageOwner>string</ImageOwner>
<ParentImageId>int</ParentImageId>
<ProgramTitle>string</ProgramTitle>
<MaxImageScale>float</MaxImageScale>
</Image>
</Images>
<VideoClips>
<VideoClip VideoTitle="string" VideoDescription="string" VideoURL="string" VideoType="string">
<VideoHandle xsi:nil="true" />
<VideoImage xsi:nil="true" />
</VideoClip>
<VideoClip VideoTitle="string" VideoDescription="string" VideoURL="string" VideoType="string">
<VideoHandle xsi:nil="true" />
<VideoImage xsi:nil="true" />
</VideoClip>
</VideoClips>
<Page>
<PageSize>int</PageSize>
<StartIndex>int</StartIndex>
<TotalRows>int</TotalRows>
<SortByColumn>
<int>int</int>
<int>int</int>
</SortByColumn>
</Page>
</GetMediaResult>
</GetMediaResponse>
</soap12:Body>
</soap12:Envelope>