V9.Common:Award

Jump to: navigation, search

Award

Contains information about an award that a program or celebrity has been nominated for or won.

Elements

NameTypeDescription
Category String Title of the award category.
DataAvailabilityFlags Integer Sum of the bit mask values that indicate what data is available about the movie, series, episode, or program. For example: if Summary and Credits data are available, then DataAvailbilityFlags will equal HasSummary + HasCredits (2 + 16) or 18.
1 HasReview
2 HasSummary
4 HasImages
8 HasAwards
16 HasCredits
32 HasVideo
64 HasSimilar
128 HasTVSeason
256 HasTVEpisodes
IsCelebrity Boolean Whether the person is a celebrity: true or false.

Note: This property is returned only for celebrity awards, not program awards.

IsWinner Boolean Whether the nomination resulted in an award: true or false.
Medium MediumType Media the award applies to.
ProgramHandle Handle Database ID the program.

Note: This property is returned only for celebrity awards, not program awards.

ProgramType String Type of program.

Note: This property is returned only for celebrity awards, not program awards.

Recipient Recipient [ ] Recipients of the award or nomination.

Note: This property is returned only for program awards, not celebrity awards.

Title String Title of the program or film.
Type AwardType Type of award.
Year Integer Year the nomination or award is for.

XML Response Example

A celebrity award.
  <Award Title="Sling Blade" Type="Oscar" Medium="Film" Category="Best Performance by an Actor in a Leading Role" Year="1996" IsWinner="false" DataAvailabilityFlags="26">
     <ProgramHandle>
        <Id>28841</Id>
        <ProviderId>2</ProviderId>
     </ProgramHandle>
     <IsCelebrity>true</IsCelebrity>
     <ProgramType>Movie</ProgramType>
  </Award>

JSON Response Example

A program award. JSON responses are available from our REST TV Listings service.
{
  "Title":"Sling Blade",
  "Type":"Screen Actors Guild Awards",
  "Medium":"None",
  "Category":"Outstanding Performance by a Cast in a Motion Picture",
  "Year":"1996",
  "IsWinner":"false",
  "DataAvailabilityFlags":"0",
  "Recipients":[
        {
           "FullName":"John Ritter",
           "DataAvailabilityFlags":"12",
           "CreditHandle":{
              "Id":"101248",
              "ProviderId":"2"
           },
           "IsCelebrity":"true",
           "IsOrganization":"false"
        },
        {
           "FullName":"Billy Bob Thornton",
           "DataAvailabilityFlags":"12",
           "CreditHandle":{
              "Id":"102017",
              "ProviderId":"2"
           },
           "IsCelebrity":"true",
           "IsOrganization":"false"
        }
  ]
}
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.Common:Award"
Personal tools