V9.Common:Image

Jump to: navigation, search

Image

Contains properties of an image returned in a response or sent in a request. In a response, it contains the information about a returned image. In a request, it carries image filters—values of images to be returned in the results. The image properties that can be used to filter returned images are shown with an asterisk (*).

Note: All image filters specified in a request are applied to the results (logical AND). The images returned meet all of the image filters specified in the request.

Elements

NameTypeDescription
AspectRatio * String Aspect ratio (width:height) of the image. Here are common aspect ratios of program and celebrity images:
Portrait Orientation    Landscape Orientation
  • 1:1
  • 3:2
  • 2:3
  • 4:3
  • 3:4
  • 5:3
  • 3:5
  • 7:4
  • 4:5
  • 16:9
  • 7:10

The aspect ratios of logos varies widely.

ImageCaption * String A description that can accompany an image that has one of the following ImageTypes:
For this ImageType . . .The ImageCaption is . . .
CelebrityLocation, date, and description of the occasion.
Gallery: KeyPeople in the image in left-to-right order.
Gallery: SupportingPeople in the image in left-to-right order.
GroupPeople in the image in left-to-right order.
Head Shot: KeyName of the cast member in the image.
Head Shot: SupportingName of the cast member in the image.
Production: KeyPeople in the image in left-to-right order.
Production: SupportingPeople in the image in left-to-right order.
Program: KeyPeople in the image in left-to-right order.
Program: SupportingPeople in the image in left-to-right order.
ImageCastWeight Nullable Float Weighting of the relative importance of the image based on relevance and prominance of cast members in the image:
  • Zero (0) means no cast members in the image.
  • A lower number means a greater weight (more cast members and more prominent cast members).
  • A higher number means a lower weight (fewer cast members and less prominent cast members).
ImageCredit String Person or company credited with taking the photograph or creating the logo. Up to 255 characters.

Note: This element is not returned if the value is empty.

ImageCreditDisplay Nullable Boolean Whether the ImageCredit must be displayed with the image.
ImageExpiryDateTime Nullable DateTime When availability of the image expires.
ImageFormat * Nullable ImageFormat Image file format: JPG or PNG.
ImageFormatId * Nullable ImageFormatId Image format ID, which indicates the associated category, image format, and maximum dimensions.

Note: Images cannot be filtered by ImageFormat ID 0.

ImageHeadcount * Nullable Integer Number of people in the image.
ImageHorizontalResolution * Nullable Integer Width of the image in pixels. Specified as a filter, returns only images with that horizontal resolution.
ImageId Nullable Integer Database ID of the image.
ImageMaintainAspectFlag Nullable Boolean Whether the aspect ratio of the source is maintained in the response.
ImageOwner String Legal owner of the image.
ImageTitle * String Value depends on ImageType:
For this ImageType . . .The ImageTitle is . . .
Box ArtMovie or program title.
CelebrityCelebrity name.
Gallery: KeyMovie or program title.
Gallery: SupportingMovie or program title.
GroupMovie or program title.
Head Shot: KeyMovie or program title.
Head Shot: SupportingMovie or program title.
Key ArtMovie or program title.
Poster ArtMovie or program title.
Production: KeyMovie or program title.
Production: SupportingMovie or program title.
Program: KeyMovie or program title.
Program: SupportingMovie or program title.
ShowcardMovie or program title.
Station LogoTV channel source name.
TrailerMovie or program title.
Vertical Showcard (3:4)   Movie or program title.
ImageType * Nullable ImageType Type of image. Images return in order of image type as shown in the ImageOrder table.
ImageUrl String URL to the image in less than 1024 characters.
ImageUseType Nullable ImageUseType Best use for the image.
ImageVerticalResolution * Nullable Integer Height of the image in pixels. Specified as a filter, returns only images with that vertical resolution.
ImageZoomLevel * Nullable ImageZoomLevel How much of the subject appears in the picture.
LastUpdate Nullable DateTime When the image was last modified.
MaxImageScale * Nullable Float In a response, the size of the image as a percentage of the original image, where 100 is the original size of the image.

In a request, the maximum size of images to be returned in the response as a percentage of the original image size. For example, a value of 25 returns only images that are scaled to 25% of the original image or less, while a value of 150 returns images scaled to 150% or less. Commonly set at 100 to filter out images that are scaled higher than the original size.

NOTE: This field is temporarily hard coded to 100 for all images and is essentially ineffective until further notice.

ObjectId Integer ID of the program, celebrity, or TV channel source that the image applies to. Which type it is (program, credit, or source) is shown in the ObjectType element.

Note:  ObjectId is not returned if ObjectType returns empty.

ObjectName String Value depends on ObjectType:
For an ObjectType of . . .The ObjectName is . . .
CreditName of the celebrity in the image and the types of credits they have earned.
ProgramTitle of the movie or program that is associated with the image.
SourceTelevision channel source that is associated with the logo.
ObjectType ImageObjectType Type of object that the image applies to:
  • Credit — A person.
  • Program — A movie or TV program.
  • Source — A TV channel programming source.
Orientation * String One of the following image orientations:
  • Portrait (height longer than or equal to the width)
  • Landscape (height shorter than the width)
ParentImageId * Nullable integer An ID that all of the files with the same image have in common. Use this property as a filter to return the available sizes and formats of a particular image.
ProgramTitle String Value depends on ImageType:
For an ImageType of . . .The value is . . .
CelebrityThe name of the celebrity.
All other image typesThe title of the movie or program that is associated with the image.

Note: This element is returned only with images with an ObjectType of Credit.

Relevancy Nullable Boolean Whether the image is directly relevant to the value returned in the ObjectName element.

XML Response Example

Here is a GetProgramDetails image (ObjectType of Program).
<Image>
   <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
   <ImageUseType xsi:nil="true"/>
   <ImageId>4891747</ImageId>
   <ImageTitle>Star Wars Episode III: Revenge of the Sith</ImageTitle>
   <ImageCaption>Poster art (large)</ImageCaption>
   <ObjectId>4818189</ObjectId>
   <ObjectType>Program</ObjectType>
   <ObjectName>Star Wars Episode III: Revenge of the Sith</ObjectName>
   <Relevancy>true</Relevancy>
   <ImageCredit>20th Century Fox</ImageCredit>
   <ImageCreditDisplay xsi:nil="true"/>
   <ImageCastWeight>1</ImageCastWeight>
   <ImageZoomLevel>3</ImageZoomLevel>
   <ImageHeadcount>4</ImageHeadcount>
   <ImageType>Poster Art</ImageType>
   <ImageFormat>jpg</ImageFormat>
   <ImageHorizontalResolution>81</ImageHorizontalResolution>
   <ImageVerticalResolution>100</ImageVerticalResolution>
   <ImageMaintainAspectFlag xsi:nil="true"/>
   <ImageExpiryDateTime xsi:nil="true"/>
   <LastUpdate>2011-10-28T14:48:27.407Z</LastUpdate>
   <ImageFormatId>51</ImageFormatId>
   <Orientation>Portrait</Orientation>
   <AspectRatio>4:5</AspectRatio>
   <ImageOwner>20th Century Fox</ImageOwner>
   <ParentImageId>16786314</ParentImageId>
   <MaxImageScale>5.5</MaxImageScale>
</Image>

XML Response Example 2

Here is a GetServiceDetails image (ObjectType of Source).
<Image>
     <ImageUrl>http://actual-url-concealed.png</ImageUrl>
     <ImageUseType xsi:nil="true"/>
     <ImageId>340660</ImageId>
     <ImageTitle>CBS</ImageTitle>
     <ImageCaption>Source Logo</ImageCaption>
     <ObjectId>5943</ObjectId>
     <ObjectType>Source</ObjectType>
     <ObjectName>CBS; CBS</ObjectName>
     <Relevancy>true</Relevancy>
     <ImageCredit>CBS</ImageCredit>
     <ImageCreditDisplay xsi:nil="true"/>
     <ImageCastWeight xsi:nil="true"/>
     <ImageZoomLevel>1</ImageZoomLevel>
     <ImageHeadcount xsi:nil="true"/>
     <ImageType>Station Logo</ImageType>
     <ImageFormat>png</ImageFormat>
     <ImageHorizontalResolution>74</ImageHorizontalResolution>
     <ImageVerticalResolution>75</ImageVerticalResolution>
     <ImageMaintainAspectFlag xsi:nil="true"/>
     <ImageExpiryDateTime xsi:nil="true"/>
     <LastUpdate>2009-02-05T10:13:15.79Z</LastUpdate>
     <ImageFormatId>25</ImageFormatId>
     <Orientation>Portrait</Orientation>
     <AspectRatio>1:1</AspectRatio>
     <ImageOwner>CBS</ImageOwner>
     <ParentImageId>16786820</ParentImageId>
     <MaxImageScale>29.84</MaxImageScale>
</Image>

XML Response Example 3

Here is a GetCelebrityDetails image (ObjectType of Credit).
<Image>
   <ImageUrl>http://actual-url-concealed.png</ImageUrl>
   <ImageUseType xsi:nil="true"/>
   <ImageId>4891803</ImageId>
   <ImageTitle>Star Wars Episode II: Attack of the Clones</ImageTitle>
   <ImageCaption>Poster art (large)</ImageCaption>
   <ObjectId>101085</ObjectId>
   <ObjectType>Credit</ObjectType>
   <ObjectName>Hayden Christensen; Actor</ObjectName>
   <Relevancy>true</Relevancy>
   <ImageCredit>20th Century Fox</ImageCredit>
   <ImageCreditDisplay xsi:nil="true"/>
   <ImageCastWeight>1</ImageCastWeight>
   <ImageZoomLevel>3</ImageZoomLevel>
   <ImageHeadcount>3</ImageHeadcount>
   <ImageType>Poster Art</ImageType>
   <ImageFormat>png</ImageFormat>
   <ImageHorizontalResolution>70</ImageHorizontalResolution>
   <ImageVerticalResolution>86</ImageVerticalResolution>
   <ImageMaintainAspectFlag xsi:nil="true"/>
   <ImageExpiryDateTime xsi:nil="true"/>
   <LastUpdate>2011-10-28T14:47:36.79Z</LastUpdate>
   <ImageFormatId>29</ImageFormatId>
   <Orientation>Portrait</Orientation>
   <AspectRatio>4:5</AspectRatio>
   <ImageOwner>20th Century Fox</ImageOwner>
   <ParentImageId>16786315</ParentImageId>
   <ProgramTitle>Star Wars Episode II: Attack of the Clones</ProgramTitle>
   <MaxImageScale>5.89</MaxImageScale>
</Image>
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.Common:Image"
Personal tools