V1.MetaData.NameService.Name:Schedule

Jump to: navigation, search

Name/Schedule

Returns a schedule of upcoming television broadcasts that include a person or group.

This request may return a large amount of data. To speed data transmission, do the following:

  • Request one page of data at a time, requesting only what you want to immediately display.
  • Request a compressed response by including Accept-Encoding: gzip,deflate in the HTTP header.

Syntax

name/schedule? name=name
nameid=nameid
cosmoid=cosmoid
amgpopid=amgpopid
amgmovieid=amgmovieid
amgclassicalid=amgclassicalid 		&apikey=apikey&sig=sig
&serviceid=serviceid [&format=format] [&offset=offset] [&count=count] [&country=country] [&language=language] [&starttime=starttime] [&duration=duration] [&inprogress=inprogress] [&copytexttype=copytexttype] [&titletype=titletype] [&sourceid=sourceid] [&sourceinclude=sourceinclude] [&sourceexclude=sourceexclude]

Request Example 1

Request a schedule of shows with Ice-T over the next two weeks on Time Warner Cable in Beverly Hills, California, and return just the first two in the list.
http://api.rovicorp.com/data/v1/name/schedule?apikey=apikey&sig=sig&cosmoid=101086&
serviceid=360861&count=2

Request Example 2

Request a schedule of shows with Salma Hayek over the next week on Digital Plus satellite in Barcelona, Spain, but request program descriptions in English if available.
http://api.rovicorp.com/data/v1/name/schedule?apikey=apikey&sig=sig&name=Salma+Hayek&
serviceid=890508&duration=10080&country=ES&language=en

Request Example 3

Request a schedule of HD movies with Salma Hayek on any of the movie channels on Time Warner Cable in Southern Manhattan over the next six hours, and include movies that are currently on.
http://api.rovicorp.com/data/v1/name/schedule?apikey=apikey&sig=sig&cosmoid=101267&
serviceid=60795&inprogress=true&duration=360&sourceinclude=HD&sourceid=433,1263,1535,
2196,2419,3818,16137,15591,17116,19433,20419,21586,22700,23458,27330

Request Example 4

Request a schedule of shows with Harrison Ford this weekend starting Friday at 6:00pm local time on SaskTel Max Cable in Moose Jaw, Saskatchewan, and return the first two results in XML format.
http://api.rovicorp.com/data/v1/name/schedule?apikey=apikey&sig=sig&name=Harrison%20Ford&
serviceid=68809&country=CA&language=en&starttime=2011-06-24T18:00:00-06:00&
duration=1800&format=xml&count=2

Request Parameters

Sort none.gif  Click to re-sort

Parameter Required Description
apiKey Yes Access code that authorizes your request for data from Rovi.
serviceid Yes Database ID of a television service. You can get service IDs of local television services with the REST call Listings/Services or the SOAP call GetServices. For US national services, you can use any of the following service IDs:
Time ZoneComplete (87+ Listings)Widget (30+ Listings)
Eastern8000184801
Central8000284800
Pacific8000484798

You can limit a returned schedule with the following optional parameters:

  • duration
  • starttime
  • inprogress
sig Yes A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
  • Your API key.
  • The secret key you received with your API key.
  • The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation.

amgclassicalid Conditional All Media Guide (AMG) ID for a classical music artist, consisting of a ten-character string that starts with Q and is followed by nine digits with leading spaces. For example: Q     9065.

When using an AMG Classical ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: Q+++++9065. AMG is a legacy database of entertainment information.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
amgmovieid Conditional All Media Guide (AMG) ID for a person who works in movies, consisting of a seven-character string that starts with P and is followed by 6 digits with leading spaces. For example: P 30474.

When using an AMG Movie ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P+30474.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
amgpopid Conditional All Media Guide (AMG) ID for a popular music artist, consisting of a ten-character string that starts with P and is followed by 9 digits with leading spaces. For example: P    84363.

When using an AMG Pop ID in a request, replace any spaces in the ID with plus (+) or percent20 (%20) symbols, like this: P++++84363.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
cosmoid Conditional Cosmo database ID for a person, group, or organization. You can get Cosmo IDs with Search requests. Cosmo is a database of television data.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
name Conditional Name of the person or group. This returns the top search result for that name. Replace any spaces with plus (+) or percent20 (%20) symbols.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
nameid Conditional Rovi Music ID for a person, group, or organization, consisting of the prefix MN followed by a ten-digit number. For example: MN0000114342. Your application can grab name IDs from responses to Search and from Info, Credits, Tracks, and Recommendations requests. For a complete list of requests that return name IDs, click here.

Condition: The request must contain just one of these parameters:

  • name
  • nameid
  • cosmoid   
  • amgpopid
  • amgmovieid
  • amgclassicalid
copytexttype No Type of description you want returned for the program, movie, or TV series. If you specify a copy type that has no content, no description is returned.
  • 1
Chrono Long. Objective, straightforward description with up to 500 characters. Includes cast members, but not regular cast members in a series unless it is a series premiere.
  • 2
Promo. A subjective and positive description. Created for pay-per-view programs and for movies that have critical (negative) Chrono Long copy.
  • 3
NoCast. Excludes cast members. Up to 400 characters for movies, or 500 characters for a series.
  • 4
Chrono Short. A shortened version of Chrono Long with up to 254 characters and cutting positions that can be used to shorten the text.
  • 5
Grid Copy. Short plot description with up to 254 characters and cutting positions that can be used to shorten the text.
  • 54
Short Synopsis. A program description with up to 150 characters.
  • 55
Synopsis. The short synopsis plus further description up to 420 characters.
  • 10001  
AMG Movie Review. A professional movie review, which may be long, and the name of the author of the review, from All Media Guide (AMG).

If you do not specify a copy type, the description chosen is based on category, shown below, and the first copy type in the category that is available:

CategoryCopy Type Fallback Sequence
Movie

1
4
55
54
3
5

Chrono Long
Chrono Short
Synopsis
Short Synopsis
No Cast
Grid
Series Master

3
55
54

No Cast
Synopsis
Short Synopsis
Series Episode

1
55
54
4
5

Chrono Long
Synopsis
Short Synopsis
Chrono Short
Grid
One Time Only

1
55
54
4
5

Chrono Long
Synopsis
Short Synopsis
Chrono Short
Grid
Season

36
38
39

Season description (for select series and seasons)
Critical description (not currently written)
Season essay (not currently written)
count No Number of items to be returned. The default is zero, which returns all items after the offset.

Use count and offset to paginate the response.

country No Country for the language that is specified as the language parameter, stated as a two-character ISO 3166 country code. Default is US (United States). Valid country codes are:
  • AR
Argentina
  • SV
 El Salvador
  • NI
Nicaragua
  • AT
Austria
  • FI
 Finland
  • NO
Norway
  • BE
Belgium
  • FR
France
  • PA
Panama
  • BM
Bermuda
  • DE
Germany
  • PE
Peru
  • BO
Bolivia
  • GT
Guatemala
  • PL
Poland
  • BR
Brazil    
  • PT
Portugal
  • CA
Canada
  • HN
Honduras
  • ES
Spain
  • CL
Chile
  • IE
Ireland
  • SE
Sweden
  • CO
Colombia
  • IT
Italy
  • CH
Switzerland
  • CR
Costa Rica
  • JM
Jamaica
  • TR
Turkey
  • DK
Denmark
  • LU
Luxembourg   
  • GB
United Kingdom*
  • DO
Dominican Republic   
  • MX
Mexico
  • US
United States
  • EC
Ecuador
  • NL
Netherlands
  • VE
Venezuela

* Includes Wales, Scotland, and Northern Ireland.

duration No The number of minutes the schedule will cover, from 1 to 20160. Default is 20160 (14 days).

Note: The schedule is determined by starttime, duration, and inprogress. A duration shorter than 5 minutes may miss shows starting just before or after a half-hour point.

format No Format of the returned data: json or xml. The default is JSON.
inprogress No Whether shows in progress at the time specified for starttime are included in the schedule: true or false. Default is false.

Note: The schedule is determined by starttime, duration, and inprogress.

language No Language of program titles, keywords, and descriptions, stated as a two-character ISO 639 language code. Valid language codes are:
  • da
Danish
  • fr
French
  • pl
Polish
  • nl
Dutch
  • de
German
  • pt
Portuguese
  • en
English    
  • it
Italian
  • es
Spanish
  • fi
Finnish
  • no
Norwegian    
  • sv
Swedish
  • fl
Flemish
  • tr
Turkish

Default is en (English). If a program description is not available in the language requested, a description in another language is provided if available. The language chosen is determined by the rules shown in the Language Fallback Sequence table.

offset No Number of items at the start of the returned list to skip. The default is zero.

Use count and offset to paginate the response.

sourceexclude No If you specify sourceid to select the television sources to be returned, sourceexclude specifies attributes of the channels in the source ID list that you want to eliminate from the channels returned. The possible values are:
  • HD
  • PPV
  • Music

You can specify multiple sourceexclude values in either of the following ways:

  • In multiple arguments, like this: sourceexclude=HD&sourceexclude=PPV.
  • In a single argument as a comma-separated list, like this: sourceexclude=HD,PPV.
sourceid No Channel sources to be included in the results. You can get source IDs from responses to a GetServiceDetails request. Note: a single television source may supply content to multiple channels.

You can specify multiple source IDs in either of the following ways:

  • In multiple arguments, like this: sourceid=14019&sourceid=11284&sourceid=10395.
  • In a single argument as a comma-separated list, like this: sourceid=14019,11284,10395.
You can filter these source IDs further with sourceinclude or sourceexclude.
sourceinclude No If you specify sourceid to select the television sources to be returned, sourceinclude specifies an attribute of the channels in the source ID list that you want to include in the list of channels returned. The possible values are:
  • HD
  • PPV
  • Music
Only channels in the source ID list that meet that attribute will be returned.
starttime No Beginning of the time period covered by the schedule, specified as a DateTime value that is between the time of the request and two weeks in the future. The default is the time of the request.

Note: The schedule is determined by duration, inprogress, and starttime.

titletype No Type of program title to return as described in the TitleType table. Most programs do not carry all title types, so we recommend using the default unless another type is required. If a program does not have the type specified, the default title is returned.

Response

Response Header

ResponseTypeDescription
buildStringThe software release level of the API.
codeIntegerHTTP status code. See the status field for the text part of the code.
durationIntegerServer processing time in milliseconds. The difference between startTime and endTime.
endTimeStringWhen the server sent the response (UTC time).
messagesMessage [ ]Elements of a multiple HTTP response status message.
parametersparametersList of the parameters included in the request.
parentIdsparentIdsAll of the IDs for the requested name that are recognized by the Name API.
serverNameStringName of the server that processed the request.
startTimeStringWhen the server received the request (UTC time).
statusStringText part of the HTTP status code that is shown in the code field.
viewviewSummary of items returned in a list of items.

Response for Name/Schedule

ResponseTypeDescription
airings VideoAiring [ ] Broadcasts that include the person or group specified in the request.
duration Integer Number of minutes the broadcast schedule covers.
locale String Language and country code of the response.
name String Name of the television service in less than 50 characters.
serviceId Integer Database ID of the television service.
serviceType ServiceType Type of television service.
startDateTime DateTime Starting date and time of the broadcast schedule.
timeZones TimeZoneInfo [ ] UTC offset applicable to a television service and when the offset begins and ends. Television broadcast times are returned in UTC time, and you need to apply the offset to calculate the local time. UTC offsets change with daylight savings time.

JSON Response Example

Here's the response to Request Example 1. It is formatted with extra spaces and carriage returns to make it easy to read.
{
   "status":"ok",
   "code":200,
   "messages":null,
   "build":"1.6.1.8",
   "parameters":{
      "apiKey":"4p1k3y",
      "id":"101086",
      "offset":0,
      "count":2,
      "serviceid":"360861"
   },
   "view":{
      "offset":0,
      "count":2,
      "total":110
   },
   "serverName":"tul1cstw2",
   "startTime":"2011-06-24T19:02:53.5430765Z",
   "endTime":"2011-06-24T19:02:57.7148180Z",
   "duration":417,
   "parentIds":{
      "amgClassicalId":"Q 300636",
      "amgMovieId":"P 34312",
      "amgPopId":"P 89063",
      "cosmoId":"101086",
      "nameId":"MN0000072003"
   },
   "schedule":{
      "locale":"en-US",
      "serviceId":360861,
      "name":"Beverly Hills - Time Warner Cable- Walnut/Diamond Bar",
      "serviceType":"Cable",
      "startDateTime":"2011-06-24T19:02:55.5273880Z",
      "duration":20160,
      "timezones":[
         {
            "startDateTime":"2011-03-13T10:00:00.0000000Z",
            "endDateTime":"2011-11-06T09:00:00.0000000Z",
            "offset":-420
         }
      ],
      "airings":[
         {
            "ids":{
               "amgMovieId":null,
               "cosmoId":"3236816"
            },
            "time":"2011-06-28T00:00:00.0000000Z",
            "type":0,
            "aspectRatio":null,
            "callLetters":"USA",
            "category":"Other",
            "atts":291,
            "channel":"33",
            "colorType":"Color",
            "desc":"A kidnapping investigation links a past case with which Cragen was involved to a 12-year-old (Ian Cronin) whose adoption is deemed illegal. Mark Sanford: Bruce Altman. Robert Cook: David Aaron Baker. Erin Blake: Ellen Parker. Adam Blake: John Sloman. Margaret Talmadge: Celia Weston. Herbert Talmadge: John Seitz. Cragen: Dann Florek. Munch: Richard Belzer. Cabot: Stephanie March.",
            "descSource":null,
            "duration":60,
            "episodeTitle":"Stolen",
            "hdLevel":0,
            "ratings":{
               "tv":"TV-14",
               "movie":null
            },
            "parentNetworkId":101,
            "seriesId":"1745480",
            "serviceId":360861,
            "showingType":0,
            "sourceDisplayName":"USA-W",
            "sourceId":2534,
            "sourceFullName":"USA Network (West)",
            "sourceName":"USA",
            "subcategory":"drama",
            "subtitleLanguage":null,
            "title":"Law & Order: Special Victims Unit"
         },
         {
            "ids":{
               "amgMovieId":null,
               "cosmoId":"3662119"
            },
            "time":"2011-07-01T07:00:00.0000000Z",
            "type":0,
            "aspectRatio":null,
            "callLetters":"KCOP",
            "category":"Other",
            "atts":289,
            "channel":"13",
            "colorType":"Color",
            "desc":"Gloria Reuben plays a graphics designer who returns from five months in rehab to discover that her daughter is missing. Terry Jessup: David Harbour. Thelma Price: Capathia Jenkins. Virginia Preston: Ileen Getz. Karen Jacobs: Aleta Mitchell. Fin: Ice-T. Benson: Mariska Hargitay. Stabler: Christopher Meloni.",
            "descSource":null,
            "duration":60,
            "episodeTitle":"Dolls",
            "hdLevel":0,
            "ratings":{
               "tv":"TV-14",
               "movie":null
            },
            "parentNetworkId":154,
            "seriesId":"1745480",
            "serviceId":360861,
            "showingType":0,
            "sourceDisplayName":"KCOP",
            "sourceId":708,
            "sourceFullName":"KCOP",
            "sourceName":"KCOP",
            "subcategory":"drama",
            "subtitleLanguage":null,
            "title":"Law & Order: Special Victims Unit"
         }
      ]
   }
}

XML Response Example

Here's the response to Request Example 4.
<NameSchedule xmlns="com.rovicorp.metadataservice" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <status>ok</status>
  <code>200</code>
  <messages i:nil="true"/>
  <build>1.6.1.8</build>
  <parameters>
    <apiKey>4p1k3y</apiKey>
    <id>Harrison Ford</id>
    <offset>0</offset>
    <count>2</count>
    <format>xml</format>
    <country>CA</country>
    <language>en</language>
    <starttime>2011-06-24T18:00:00-06:00</starttime>
    <duration>1800</duration>
    <serviceid>890113</serviceid>
  </parameters>
  <view>
    <offset>0</offset>
    <count>2</count>
    <total>6</total>
  </view>
  <serverName>tul1cstw3</serverName>
  <startTime>2011-06-24T20:12:30.6215409Z</startTime>
  <endTime>2011-06-24T20:12:31.4496447Z</endTime>
  <duration>296</duration>
  <parentIds>
    <amgClassicalId>Q 1210728</amgClassicalId>
    <amgMovieId>P 24238</amgMovieId>
    <amgPopId>P 321012</amgPopId>
    <cosmoId>100934</cosmoId>
    <nameId>MN0001325256</nameId>
  </parentIds>
  <schedule>
    <locale>en-CA</locale>
    <serviceId>890113</serviceId>
    <name>Regina - SaskTel Max</name>
    <serviceType>Cable</serviceType>
    <startDateTime>2011-06-25T00:00:00.0000000Z</startDateTime>
    <duration>1800</duration>
    <timezones>
      <TimeZoneInfo>
        <startDateTime>2011-01-01T06:00:00.0000000Z</startDateTime>
        <endDateTime>2012-01-01T06:00:00.0000000Z</endDateTime>
        <offset>-360</offset>
      </TimeZoneInfo>
    </timezones>
    <airings>
      <VideoAiring>
        <ids>
          <amgMovieId i:nil="true"/>
          <cosmoId>2946507</cosmoId>
        </ids>
        <time>2011-06-25T20:00:00.0000000Z</time>
        <type>Unknown</type>
        <aspectRatio i:nil="true"/>
        <callLetters>DUSK</callLetters>
        <category>Movie</category>
        <atts>257</atts>
        <channel>83</channel>
        <colorType>Color</colorType>
        <desc>Harrison Ford and Michelle Pfeiffer play a couple whose house appears to be haunted in this Hitchcockian thriller from director Robert Zemeckis (“Cast Away”). Jody: Diana Scarwid. Dr. Drayton: Joe Morton. Warren: James Remar.</desc>
        <descSource i:nil="true"/>
        <duration>180</duration>
        <episodeTitle i:nil="true"/>
        <hdLevel>Unknown</hdLevel>
        <ratings>
          <tv>None</tv>
          <movie>PG-13</movie>
        </ratings>
        <parentNetworkId>0</parentNetworkId>
        <seriesId i:nil="true"/>
        <serviceId>890113</serviceId>
        <showingType>Unknown</showingType>
        <sourceDisplayName>DUSK-E</sourceDisplayName>
        <sourceId>10128</sourceId>
        <sourceFullName>DUSK (East)</sourceFullName>
        <sourceName>DUSK</sourceName>
        <subcategory>mystery &amp; suspense</subcategory>
        <subtitleLanguage i:nil="true"/>
        <title>What Lies Beneath</title>
      </VideoAiring>
      <VideoAiring>
        <ids>
          <amgMovieId i:nil="true"/>
          <cosmoId>2946507</cosmoId>
        </ids>
        <time>2011-06-25T14:00:00.0000000Z</time>
        <type>Unknown</type>
        <aspectRatio i:nil="true"/>
        <callLetters>DUSK</callLetters>
        <category>Movie</category>
        <atts>257</atts>
        <channel>83</channel>
        <colorType>Color</colorType>
        <desc>Harrison Ford and Michelle Pfeiffer play a couple whose house appears to be haunted in this Hitchcockian thriller from director Robert Zemeckis (“Cast Away”). Jody: Diana Scarwid. Dr. Drayton: Joe Morton. Warren: James Remar.</desc>
        <descSource i:nil="true"/>
        <duration>180</duration>
        <episodeTitle i:nil="true"/>
        <hdLevel>Unknown</hdLevel>
        <ratings>
          <tv>None</tv>
          <movie>PG-13</movie>
        </ratings>
        <parentNetworkId>0</parentNetworkId>
        <seriesId i:nil="true"/>
        <serviceId>890113</serviceId>
        <showingType>Unknown</showingType>
        <sourceDisplayName>DUSK-E</sourceDisplayName>
        <sourceId>10128</sourceId>
        <sourceFullName>DUSK (East)</sourceFullName>
        <sourceName>DUSK</sourceName>
        <subcategory>mystery &amp; suspense</subcategory>
        <subtitleLanguage i:nil="true"/>
        <title>What Lies Beneath</title>
      </VideoAiring>
    </airings>
  </schedule>
</NameSchedule>


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V1.MetaData.NameService.Name:Schedule"
Personal tools