API:Base Series Record

From TvDBwiki
Jump to: navigation, search

The Base Series Record contains all of the information available about a series. It does not include any banner, season, or episode information.

Parameters

id

An unsigned integer assigned by our site to the series. It does not change and will always represent the same series. Cannot be null.

Actors

A pipe delimited string of actors in plain text. Begins and ends with a pipe even if no actors are listed. Cannot be null.

Airs_DayOfWeek

The full name in English for the day of the week the series airs in plain text. Can be null.

Airs_Time

A string indicating the time of day the series airs on its original network. Format "HH:MM AM/PM". Can be null.

ContentRating

The rating given to the series based on the US rating system. Can be null or a 4-5 character string.

FirstAired

A string containing the date the series first aired in plain text using the format "YYYY-MM-DD". Can be null.

Genre

Pipe delimited list of genres in plain text. Begins and ends with a | but may also be null.

IMDB_ID

An alphanumeric string containing the IMDB ID for the series. Can be null.

Language

A two character string indicating the language in accordance with ISO-639-1. Cannot be null.

Network

A string containing the network name in plain text. Can be null.

NetworkID

Not in use, will be an unsigned integer if ever used. Can be null.

Overview

A string containing the overview in the language requested. Will return the English overview if no translation is available in the language requested. Can be null.

Rating

The average rating our users have rated the series out of 10, rounded to 1 decimal place. Can be null.

RatingCount

An unsigned integer representing the number of users who have rated the series. Can be null.

Runtime

An unsigned integer representing the runtime of the series in minutes. Can be null.

SeriesID

Deprecated. An unsigned integer representing the series ID at tv.com. As TV.com now only uses these ID's internally it's of little use and no longer updated. Can be null.

SeriesName

A string containing the series name in the language you requested. Will return the English name if no translation is found in the language requested. Can be null if the name isn't known in the requested language or English.

Status

A string containing either "Ended" or "Continuing". Can be null.

added

A string containing the date/time the series was added to our site in the format "YYYY-MM-DD HH:MM:SS" based on a 24 hour clock. Is null for older series.

addedBy

An unsigned integer. The ID of the user on our site who added the series to our database. Is null for older series.

banner

A string which should be appended to <mirrorpath>/banners/ to determine the actual location of the artwork. Returns the highest voted banner for the requested series. Can be null.

fanart

A string which should be appended to <mirrorpath>/banners/ to determine the actual location of the artwork. Returns the highest voted fanart for the requested series. Can be null.

lastupdated

Unix time stamp indicating the last time any changes were made to the series. Can be null.

posters

A string which should be appended to <mirrorpath>/banners/ to determine the actual location of the artwork. Returns the highest voted poster for the requested series. Can be null.

zap2it_id

An alphanumeric string containing the zap2it id. Can be null.

Example Results

<?xml version="1.0" encoding="UTF-8" ?>
<Series>
  <id>80348</id> 
  <Actors>|Zachary Levi|Yvonne Strahovski|Joshua Gomez|Adam Baldwin|</Actors> 
  <Airs_DayOfWeek>Friday</Airs_DayOfWeek> 
  <Airs_Time>8:00 PM</Airs_Time> 
  <ContentRating>TV-PG</ContentRating> 
  <FirstAired>2007-09-24</FirstAired> 
  <Genre>|Action|Adventure|Comedy|Drama|</Genre> 
  <IMDB_ID>tt0934814</IMDB_ID> 
  <Language>en</Language> 
  <Network>NBC</Network> 
  <NetworkID /> 
  <Overview>Chuck Bartowski, ace computer geek at Buy More, is not in his...</Overview> 
  <Rating>8.8</Rating> 
  <RatingCount>818</RatingCount> 
  <Runtime>60</Runtime> 
  <SeriesID>68724</SeriesID> 
  <SeriesName>Chuck</SeriesName> 
  <Status>Ended</Status> 
  <added /> 
  <addedBy /> 
  <banner>graphical/80348-g32.jpg</banner> 
  <fanart>fanart/original/80348-48.jpg</fanart> 
  <lastupdated>1369940177</lastupdated> 
  <poster>posters/80348-16.jpg</poster> 
  <zap2it_id>EP00930779</zap2it_id> 
</Series>
Personal tools