V9.Common:ImageRest

Jump to: navigation, search

Image

Contains information about an image.

Elements

NameTypeDescription
AspectRatio String Aspect ratio (width:height) of the image.
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 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 Boolean Whether the ImageCredit must be displayed with the image.
ImageExpiryDateTime DateTime When availability of the image expires.
ImageFormat ImageFormat Image file format: JPG or PNG.
ImageFormatId ImageFormatId Image format ID, which indicates the associated category, image format, and maximum dimensions.
ImageHeadcount Integer Number of people in the image.
ImageHorizontalResolution Integer Width of the image in pixels.
ImageId Integer Database ID of the image.
ImageMaintainAspectFlag 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 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 ImageUseType Best use for the image.
ImageVerticalResolution Integer Height of the image in pixels.
ImageZoomLevel ImageZoomLevel How much of the subject appears in the picture.
LastUpdate DateTime When the image was last modified.
MaxImageScale Float The size of the image as a percentage of the original image, where 100 is the original size of the image.

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 Integer An ID that all of the files with the same image have in common.
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 Boolean Whether the image is directly relevant to the value returned in the ObjectName element.

XML Response Example

  <Image>
     <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
     <ImageUseType xsi:nil="true"/>
     <ImageId>2388482</ImageId>
     <ImageTitle>Standing in the Shadows of Motown</ImageTitle>
     <ImageCaption>Box Art</ImageCaption>
     <ObjectId>3829144</ObjectId>
     <ObjectType>Program</ObjectType>
     <ObjectName>Standing in the Shadows of Motown</ObjectName>
     <Relevancy>true</Relevancy>
     <ImageCreditDisplay xsi:nil="true"/>
     <ImageCastWeight>0</ImageCastWeight>
     <ImageZoomLevel>3</ImageZoomLevel>
     <ImageHeadcount xsi:nil="true"/>
     <ImageType>Box Art</ImageType>
     <ImageFormat xsi:nil="true"/>
     <ImageHorizontalResolution>926</ImageHorizontalResolution>
     <ImageVerticalResolution>1291</ImageVerticalResolution>
     <ImageMaintainAspectFlag xsi:nil="true"/>
     <ImageExpiryDateTime xsi:nil="true"/>
     <LastUpdate>2010-10-06T14:09:44.537Z</LastUpdate>
     <ImageFormatId xsi:nil="true"/>
     <Orientation>Portrait</Orientation>
     <AspectRatio>7:10</AspectRatio>
     <ParentImageId>16883640</ParentImageId>
     <MaxImageScale>100</MaxImageScale>
  </Image>

JSON Response Example

JSON responses are available from our REST TV Listings service.
{
   "ImageUrl":"http:\/\/actual-url-concealed.jpg",
   "ImageUseType":null,
   "ImageId":1122047,
   "ImageTitle":"Jay Leno",
   "ImageCaption":"PASADENA, CA - AUGUST 05: Jay Leno arrives at NBC Universal's all-star press tour party on August 5, 2009 in Pasadena, California.",
   "ObjectId":"100614",
   "ObjectType":"Credit",
   "ObjectName":"Jay Leno;Actor; Voice-overs; Executive Producer; Host",
   "Relevancy":"true",
   "ImageCredit":"Jason Merritt\/Getty Images Entertainment\/Getty Images",
   "ImageCreditDisplay":null,
   "ImageCastWeight":null,
   "ImageZoomLevel":"1",
   "ImageHeadcount":1,
   "ImageType":"Celebrity",
   "ImageFormat":"jpg",
   "ImageHorizontalResolution":209,
   "ImageVerticalResolution":326,
   "ImageMaintainAspectFlag":null,
   "ImageExpiryDateTime":null,
   "LastUpdate":"2010-01-05T14:13:03.06Z",
   "ImageFormatId":40,
   "Orientation":"Portrait",
   "AspectRatio":"2:3",
   "ParentImageId":16849425,
   "ProgramTitle":"Jay Leno",
   "MaxImageScale":"100"
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.Common:ImageRest"
Personal tools