Series details

/series/:seriesId

Returns detailed metadata for a given series.

Request Parameters

Parameter

Mandatory?

Description

seriesId

Yes

seriesId, which can be found in program metadata of Airings methods or Program Details

imageSize

No

Valid values are: Sm, Md, Lg, Ms. See Image Sizing for details.
If not specified, defaults to Md (medium).
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.

titleLang No Filter results based on the specified title language. Use IETF language tags (2-letter abbreviations, with optional 2-letter region extensions). If not specified, defaults to 'en'.

descriptionLang

No

Specify description language preference using IETF language tags (2-letter abbreviations, with optional 2-letter region extensions). If program description not available in specified language, primary TMS ID will be returned regardless of description language.  If not specified, preference defaults to English.

api_key

Yes

24-character key obtained during application registration

Response Body

Response

Type

Description

Series info

Program

Information regarding specified series.

Sample Request

http://data.tmsapi.com/v1.1/series/185044?api_key=1234567890

Sample Response

{
  "tmsId":"SH006883590000",
  "rootId":"185044",
  "seriesId":"185044",
  "subType":"Series",
  "title":"House",
  "releaseYear":2004,
  "releaseDate":"2004",
  "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" }, 
    { "billingOrder":"03", "role":"Actor", "nameId":"72370", "personId":"72370", "name":"Omar Epps", "characterName":"Dr. Eric Foreman" }, 
    { "billingOrder":"04", "role":"Actor", "nameId":"202782", "personId":"200896", "name":"Jesse Spencer", "characterName":"Dr. Robert Chase" }, 
    { "billingOrder":"05", "role":"Actor", "nameId":"169539", "personId":"168500", "name":"Peter Jacobson", "characterName":"Dr. Chris Taub" }, 
    { "billingOrder":"06", "role":"Actor", "nameId":"637331", "personId":"488417", "name":"Odette Annable", "characterName":"Dr. Jessica Adams" }, 
    { "billingOrder":"07", "role":"Actor", "nameId":"511642", "personId":"497604", "name":"Charlyne Yi", "characterName":"Dr. Chi Park" }
  ],
  "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" }, 
    { "billingOrder":"03", "role":"Executive Producer", "nameId":"203480", "personId":"201573", "name":"David Shore" }, 
    { "billingOrder":"04", "role":"Executive Producer", "nameId":"160710", "personId":"160143", "name":"Bryan Singer" }
  ],
  "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" }, 
    { "awardId":"3", "recipient":"Hugh Laurie", "name":"Screen Actors Guild Awards", "awardName":"Screen Actors Guild Awards", "personId":"87269", "won":"true", "year":"2006", "category":"Outstanding Performance by a Male Actor in a Drama Series", "awardCatId":"124" },
    ... additional awards ...
  ],
  "keywords":{
    "Mood":[ "Fascinating", "Quirky", "Suspenseful" ], 
    "Time Period":[ "2000s" ], 
    "Theme":[ "Mystery" ], 
    "Character":[ "Doctor", "Friend", "Hospital administrator", "Neurologist" ], 
    "Setting":[ "Hospital", "New Jersey" ], 
    "Subject":[ "Medical profession", "Investigation", "Drug addiction", "Unlikely hero", "Misanthropy", "Medical mystery" ]
  },
  "ratings":[ { "code":"TVPG", "body":"USA Parental Rating" } ],
  "recommendations":[
    {
      "tmsId":"SH005116510000",
      "root":"184807",
      "title":"Monk"
    },
    {
      "tmsId":"SH007322830000",
      "root":"185019",
      "title":"Grey's Anatomy"
    },
    {
      "tmsId":"SH011063720000",
      "root":"191739",
      "title":"Lie to Me"
    }
  ],
  "preferredImage":{
    "width":"240",
    "height":"360",
    "uri":"assets/p185044_b_v5_aa.jpg",
    "category":"Banner-L1",
    "text":"yes",
    "primary":"true",
    "tier":"Series"
  }
}