Program details

/programs/:tmsId

Returns detailed metadata about a specified program. Response metadata will differ based on program type (movie, show, episode, sport).

Request Parameters

Parameter	Mandatory?	Description
tmsId or rootid	Yes	TMS ID, unique program identifier, obtained from APIs returning airings or program information rootID, this numeric ID is used to identify all related program records with different title, description language, and version. See below for additional information.
imageSize	No	Valid values are: Sm, Md, Lg, Ms. See Image Sizing for details. If not specified, defaults to Md If requested image size is not available, generic image will be returned.
imageAspectTV	No	Requested aspect ratio (horizontal by vertical) for TV show images Valid values are: 2x3, 3x4, 4x3, 16x9 If not specified, defaults to 2x3 If requested aspect ratio is not available, generic image will be returned.
imageText	No	Boolean indicating preference for image types with text (banners) or without text (iconics). If requested preference is not available, image selection will continue to next type (banner/iconic), before finally returning generic if no image found. Defaults to true for text preference.
api_key	Yes	24-character key obtained during application registration

Response Body

Response	Type	Description
Program details	Program	Detailed metadata for specified program.

Using 'rootId' as parameter

The service will always return the program with the lowest TMSID. If you are looking for specific language results the "TitleLang" and "descriptionLang" parameter can be used.

Use Case: TMS Root ID (default - language unspecified)
Example: http://data.tmsapi.com/v1.1/programs/185044
Behavior: Returns the program with lowest tmsid (English) title and descriptions.

Use Case: TMS RootID with titleLang and descriptionLang
Example: http://data.tmsapi.com/v1.1/programs/185044?titleLang=es&descriptionLang=es
Behavior: TMS Root ID to TMS ID is a 1:N relationship so this returns the program with a Spanish title and description

Use Case: TMS Root ID has more than 1 language record associated.
Example: http://data.tmsapi.com/v1.1/programs/9991634?api_key=
Behavior: The program with the lowest TMSID is returned. This will mainly happen with movies, the movies has multiple versions as per our versions endpoint http://data.tmsapi.com/v1.1/movies/9991634/versions?api_key=

Example: http://data.tmsapi.com/v1.1/programs/SH006883590000
Behavior: TMS ID to program is a 1:1 relationship so this returns the program in its assigned title and description language.

Sample Request

http://data.tmsapi.com/v1.1/programs/SH006883590000?imageSize=Lg&imageAspectTV=3x4&api_key=1234567890

Sample Response

{
  "tmsId":"SH006883590000",
  "rootId":"185044",
  "seriesId":"185044",
  "subType":"Series",
  "title":"House",
  "origAirDate":"2004-11-16",
  "titleLang":"en",
  "descriptionLang":"en",
  "entityType":"Show",
  "genres":["Drama", "Mystery", "Medical"],
  "longDescription":"At fictional Princeton Plainsboro Teaching Hospital in New Jersey, prickly genius Dr. Gregory House tackles health mysteries as would a medical Sherlock Holmes, all the while playing mind games with colleagues that include his best friend, oncologist James Wilson. House, an acerbic infectious disease specialist, solves medical puzzles with the help of a team of young diagnosticians. Flawless instincts and unconventional thinking help earn House great respect, despite his brutal honesty and antisocial tendencies.",
  "shortDescription":"A brilliant and acerbic diagnostician leads a team of specialists.",
  "totalEpisodes": 178,
  "totalSeasons":" 8",
  "cast":[
    {
      "billingOrder":"01",
      "role":"Actor",
      "nameId":"87269",
      "personId":"87269",
      "name":"Hugh Laurie",
      "characterName":"Dr. Gregory House"
    },
    {
      "billingOrder":"02",
      "role":"Actor",
      "nameId":"55541",
      "personId":"55541",
      "name":"Robert Sean Leonard",
      "characterName":"Dr. James Wilson"
    },
    ... additional cast ...
  ],
  "crew":[
    {
      "billingOrder":"01",
      "role":"Executive Producer",
      "nameId":"71245",
      "personId":"71245",
      "name":"Paul Attanasio"
    },
    {
      "billingOrder":"02",
      "role":"Executive Producer",
      "nameId":"290570",
      "personId":"286801",
      "name":"Katie Jacobs"
    },
    ... additional crew ...
  ],
  "awards":[
    {
      "awardId":"4",
      "name":"Emmy (Primetime)",
      "awardName":"Emmy (Primetime)",
      "won":"true",
      "year":"2005",
      "category":"Outstanding Writing for a Drama Series",
      "awardCatId":"68"
    },
    {
      "awardId":"4",
      "recipient":"Hugh Laurie",
      "name":"Emmy (Primetime)",
      "awardName":"Emmy (Primetime)",
      "personId":"87269",
      "year":"2005",
      "category":"Outstanding Lead Actor in a Drama Series",
      "awardCatId":"78"
    },
    {
      "awardId":"2",
      "recipient":"Hugh Laurie",
      "name":"Golden Globe",
      "awardName":"Golden Globe",
      "personId":"87269",
      "won":"true",
      "year":"2006",
      "category":"Best Performance by an Actor in a Television Series - Drama",
      "awardCatId":"117"
    },
    ... additional awards ...
  ],
  
  "preferredImage":{
    "width":"540", "height":"720",
    "uri":"assets/p185044_b_v4_aa.jpg",
    "category":"Banner-L1",
    "text":"yes", "primary":"true",
    "tier":"Series"
  }
}

version 5 as of 4 years ago by Raimond