V9.ListingsService:GetProgramDetailsExamples

Jump to: navigation, search

GetProgramDetails Request Examples

Here are some examples that show how you can use GetProgramDetails.

« GetProgramDetails

Request Example 1

Request information about the movie The Tourist.

  • Specify Program in the Metadata element to return information about the movie.
  • Specify Keyword in the Metadata element to return descriptive categories that apply to the movie.
  • Specify the program ID of the movie in the ProgramHandle element (get program IDs from a GetGridSchedule or GetLinearSchedule response.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:lis="http://api.rovicorp.com/v9/listings">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <lis:GetProgramDetails>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ProgramHandle>
               <lis:Id>17820959</lis:Id>
               <lis:ProviderId>2</lis:ProviderId>
            </lis:ProgramHandle>
            <lis:MetaData>
               <lis:ProgramMetaData>Program</lis:ProgramMetaData>
               <lis:ProgramMetaData>Keyword</lis:ProgramMetaData>
            </lis:MetaData>
            <lis:Format>PlainText</lis:Format>
            <lis:ServiceId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:InProgress xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:TitleType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:CopyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterAdultContents xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterCopyTextSource xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ImageCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </lis:request>
      </lis:GetProgramDetails>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length several ParentalRating elements have been deleted.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetProgramDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetProgramDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">678b71d0-7eca-4059-ac2b-2372823619f0</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-02T22:56:40.632Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-02T22:56:40.647Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Program DataAvailabilityFlags="127">
               <ProgramHandle>
                  <Id>17820959</Id>
                  <ProviderId>2</ProviderId>
               </ProgramHandle>
               <TvObjectId>0</TvObjectId>
               <MasterTitle>The Tourist</MasterTitle>
               <EpisodeTitle/>
               <CopyText>American tourist Frank (Johnny Depp) is dragged into a dangerous world of intrigue and espionage after crossing paths with mysterious beauty Elise (Angelina Jolie) while traveling Europe by train. Before long, Frank is dodging bullets in Paris and the winding canals of Venice, but the faster he and Elise run, the more intense their romance grows.</CopyText>
               <Runtime>103</Runtime>
               <ProgramType>Movie</ProgramType>
               <Category>Movie</Category>
               <Subcategory>mystery &amp; suspense</Subcategory>
               <ReleaseYear>2010</ReleaseYear>
               <Season/>
               <EpisodeNumber/>
               <PartNumber>0</PartNumber>
               <PartTotal>0</PartTotal>
               <StarRating>0</StarRating>
               <TVRating>None</TVRating>
               <MovieRating>PG-13</MovieRating>
               <Subtitled>false</Subtitled>
               <Letterbox>false</Letterbox>
               <CC>true</CC>
               <Color>Color</Color>
               <OriginalAirDate xsi:nil="true"/>
               <Syndicated>false</Syndicated>
               <Keywords>
                  <string>mystery &amp; suspense</string>
                  <string>suspense/thriller</string>
               </Keywords>
               <Credits/>
               <ProgramImages/>
               <IsVideoAvailable xsi:nil="true"/>
               <SeasonSequence xsi:nil="true"/>
               <SeriesSequence xsi:nil="true"/>
               <LastAirDate xsi:nil="true"/>
               <CuttingPositions>
                  <int>196</int>
                  <int>276</int>
               </CuttingPositions>
               <ParentalRatings>
                  <ParentalRating>
                     <RatingType>FCTV</RatingType>
                     <Rating>None</Rating>
                     <Reasons/>
                  </ParentalRating>
                  <ParentalRating>
                     <RatingType>Italy TV</RatingType>
                     <Rating>None</Rating>
                     <Reasons/>
                  </ParentalRating>
                  <ParentalRating>
                     <RatingType>MPAA</RatingType>
                     <Rating>PG-13</Rating>
                     <Reasons>
                        <string>SL</string>
                        <string>V</string>
                     </Reasons>
                  </ParentalRating>
               </ParentalRatings>
               <ProgramVariants/>
               <ProgramVideoClips/>
               <ProgramAwards/>
               <ProgramLanguage>English</ProgramLanguage>
               <CopyTextLanguage>English</CopyTextLanguage>
               <ShowSeasons/>
               <UnsequencedEpisodes/>
               <Streamable>1</Streamable>
            </Program>
            <Page>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>0</TotalRows>
            </Page>
            <UnsequencedEpisodePage>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>0</TotalRows>
            </UnsequencedEpisodePage>
         </GetProgramDetailsResult>
      </GetProgramDetailsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 2

Request the broadcast schedule of Star Trek: Next Generation on my cable service over the next week.
  • Specify the ServiceId of the cable service (get the ServiceId from a GetServices response).
  • Specify the time with StartDate and Duration.
  • Specify the program ID in the ProgramHandle element (get program IDs from a GetGridSchedule or GetLinearSchedule response.
  • Use SortByColumn to sort the schedule by channel and then by time on each channel.
  • Use Page to return just the first three shows in the response.
  • Use Image to return a showcard logo of the show in an ImageFormatId of 40.
  • Use ImageCount to return just one image.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:lis="http://api.rovicorp.com/v9/listings">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <lis:GetProgramDetails>
         <lis:request>
            <lis:Image>
               <lis:ImageUseType>Logo</lis:ImageUseType>
               <lis:ImageType>Showcard</lis:ImageType>
               <lis:ImageFormatId>40</lis:ImageFormatId>
            </lis:Image>
            <lis:Locale>en-US</lis:Locale>
            <lis:ProgramHandle>
               <lis:Id>585866</lis:Id>
               <lis:ProviderId>2</lis:ProviderId>
            </lis:ProgramHandle>
            <lis:MetaData>
               <lis:ProgramMetaData>Image</lis:ProgramMetaData>
            </lis:MetaData>
            <lis:Format>PlainText</lis:Format>
            <lis:ServiceId>360861</lis:ServiceId>
            <lis:StartDate>2011-06-02T12:00:00.000-08:00</lis:StartDate>
            <lis:Duration>10080</lis:Duration>
            <lis:InProgress>false</lis:InProgress>
            <lis:TitleType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:CopyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Page>
               <lis:PageSize>3</lis:PageSize>
               <lis:StartIndex>0</lis:StartIndex>
               <lis:TotalRows>0</lis:TotalRows>
               <lis:SortByColumn>
                  <lis:int>30</lis:int>
                  <lis:int>10</lis:int>
               </lis:SortByColumn>
            </lis:Page>
            <lis:FilterAdultContents xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterCopyTextSource xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ImageCount>1</lis:ImageCount>
         </lis:request>
      </lis:GetProgramDetails>
   </soapenv:Body>
</soapenv:Envelope>

This request returns the following response.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetProgramDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetProgramDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">ab9efe5a-f67d-4308-948d-d3e85141e414</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T00:57:05.565Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T00:57:05.612Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Program DataAvailabilityFlags="0">
               <ProgramHandle>
                  <Id>585866</Id>
                  <ProviderId>2</ProviderId>
               </ProgramHandle>
               <TvObjectId>0</TvObjectId>
               <MasterTitle/>
               <EpisodeTitle/>
               <CopyText/>
               <Runtime>0</Runtime>
               <ProgramType/>
               <Category/>
               <Subcategory/>
               <ReleaseYear>0</ReleaseYear>
               <Season/>
               <EpisodeNumber/>
               <PartNumber>0</PartNumber>
               <PartTotal>0</PartTotal>
               <StarRating>0</StarRating>
               <TVRating/>
               <MovieRating/>
               <Subtitled>false</Subtitled>
               <Letterbox>false</Letterbox>
               <CC>false</CC>
               <Color/>
               <OriginalAirDate xsi:nil="true"/>
               <Syndicated>false</Syndicated>
               <Keywords/>
               <Credits/>
               <ProgramImages>
                  <Image>
                     <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                     <ImageUseType xsi:nil="true"/>
                     <ImageId>4666919</ImageId>
                     <ImageTitle>Star Trek: The Next Generation</ImageTitle>
                     <ImageCaption>Showcard</ImageCaption>
                     <ObjectId>585866</ObjectId>
                     <ObjectType>Program</ObjectType>
                     <ObjectName>Star Trek: The Next Generation</ObjectName>
                     <Relevancy>true</Relevancy>
                     <ImageCredit>SCI FI</ImageCredit>
                     <ImageCreditDisplay xsi:nil="true"/>
                     <ImageCastWeight>1</ImageCastWeight>
                     <ImageZoomLevel>4</ImageZoomLevel>
                     <ImageHeadcount>8</ImageHeadcount>
                     <ImageType>Showcard</ImageType>
                     <ImageFormat>jpg</ImageFormat>
                     <ImageHorizontalResolution>246</ImageHorizontalResolution>
                     <ImageVerticalResolution>184</ImageVerticalResolution>
                     <ImageMaintainAspectFlag xsi:nil="true"/>
                     <ImageExpiryDateTime xsi:nil="true"/>
                     <LastUpdate>2011-04-29T13:21:17.367Z</LastUpdate>
                     <ImageFormatId>40</ImageFormatId>
                     <Orientation>Landscape</Orientation>
                     <AspectRatio>4:3</AspectRatio>
                     <ImageOwner>SCI FI</ImageOwner>
                     <ParentImageId>16910733</ParentImageId>
                     <MaxImageScale>49.2</MaxImageScale>
                  </Image>
               </ProgramImages>
               <IsVideoAvailable xsi:nil="true"/>
               <SeasonSequence xsi:nil="true"/>
               <SeriesSequence xsi:nil="true"/>
               <LastAirDate xsi:nil="true"/>
               <ParentalRatings/>
               <ProgramVariants/>
               <ProgramVideoClips/>
               <ProgramAwards/>
               <ShowSeasons/>
               <UnsequencedEpisodes/>
               <Streamable xsi:nil="true"/>
            </Program>
            <Schedule>
               <Locale>en-US</Locale>
               <ServiceId>360861</ServiceId>
               <Name>Beverly Hills - Time Warner Cable- Walnut/Diamond Bar</Name>
               <ServiceType>Cable</ServiceType>
               <StartDate>2011-06-02T20:00:00Z</StartDate>
               <Duration>10080</Duration>
               <TimeZones>
                  <TimeZoneInfo>
                     <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                     <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                     <Offset>-420</Offset>
                  </TimeZoneInfo>
               </TimeZones>
               <Airings>
                  <ListingsAiring>
                     <ProgramId>800903</ProgramId>
                     <SeriesId>585866</SeriesId>
                     <InstanceId xsi:nil="true"/>
                     <UnknownInstance>false</UnknownInstance>
                     <Title>Star Trek: The Next Generation</Title>
                     <EpisodeTitle>The Wounded</EpisodeTitle>
                     <Copy>A Federation captain attacks the Cardassians. Bob Gunton, Marc Alaimo, John Hancock.</Copy>
                     <AiringTime>2011-06-03T08:00:00Z</AiringTime>
                     <Duration>60</Duration>
                     <Color>Color</Color>
                     <AiringType>Unknown</AiringType>
                     <ShowingType>Unknown</ShowingType>
                     <CC>true</CC>
                     <LetterBox>false</LetterBox>
                     <Stereo>true</Stereo>
                     <HD>false</HD>
                     <SAP>false</SAP>
                     <TVRating>TV-PG</TVRating>
                     <Dolby>false</Dolby>
                     <DSS>false</DSS>
                     <HDLevel>HD Level Unknown</HDLevel>
                     <Sports>false</Sports>
                     <DVS>false</DVS>
                     <Category>Other</Category>
                     <Subcategory>sci-fi</Subcategory>
                     <SourceId>1280</SourceId>
                     <Channel>26</Channel>
                     <CallLetters>WGNAMER</CallLetters>
                     <SourceDisplayName>WGNAMER</SourceDisplayName>
                     <SourceLongName>WGN America</SourceLongName>
                     <TiVoSupported>true</TiVoSupported>
                     <ParentNetworkId>0</ParentNetworkId>
                     <IconAvailable>false</IconAvailable>
                     <ServiceId>360861</ServiceId>
                     <DvbTriplet/>
                     <SL>false</SL>
                     <Subtitles>false</Subtitles>
                  </ListingsAiring>
                  <ListingsAiring>
                     <ProgramId>800485</ProgramId>
                     <SeriesId>585866</SeriesId>
                     <InstanceId xsi:nil="true"/>
                     <UnknownInstance>false</UnknownInstance>
                     <Title>Star Trek: The Next Generation</Title>
                     <EpisodeTitle>Devil's Due</EpisodeTitle>
                     <Copy>The Enterprise comes to the aid of the Ventaxians. Ardra: Marta Du Bois. Dr. Clarke: Paul Lambert. Jared: Marcelo Tubert. Marley: William Glover.</Copy>
                     <AiringTime>2011-06-04T08:00:00Z</AiringTime>
                     <Duration>60</Duration>
                     <Color>Color</Color>
                     <AiringType>Unknown</AiringType>
                     <ShowingType>Unknown</ShowingType>
                     <CC>true</CC>
                     <LetterBox>false</LetterBox>
                     <Stereo>true</Stereo>
                     <HD>false</HD>
                     <SAP>false</SAP>
                     <TVRating>TV-PG</TVRating>
                     <Dolby>false</Dolby>
                     <DSS>false</DSS>
                     <HDLevel>HD Level Unknown</HDLevel>
                     <Sports>false</Sports>
                     <DVS>false</DVS>
                     <Category>Other</Category>
                     <Subcategory>sci-fi</Subcategory>
                     <SourceId>1280</SourceId>
                     <Channel>26</Channel>
                     <CallLetters>WGNAMER</CallLetters>
                     <SourceDisplayName>WGNAMER</SourceDisplayName>
                     <SourceLongName>WGN America</SourceLongName>
                     <TiVoSupported>true</TiVoSupported>
                     <ParentNetworkId>0</ParentNetworkId>
                     <IconAvailable>false</IconAvailable>
                     <ServiceId>360861</ServiceId>
                     <DvbTriplet/>
                     <SL>false</SL>
                     <Subtitles>false</Subtitles>
                  </ListingsAiring>
                  <ListingsAiring>
                     <ProgramId>1023378</ProgramId>
                     <SeriesId>585866</SeriesId>
                     <InstanceId xsi:nil="true"/>
                     <UnknownInstance>false</UnknownInstance>
                     <Title>Star Trek: The Next Generation</Title>
                     <EpisodeTitle>Clues</EpisodeTitle>
                     <Copy>Picard suspects Data of lying about a phenomenon that rendered the crew unconscious. Geordi: LeVar Burton. Worf: Michael Dorn.</Copy>
                     <AiringTime>2011-06-07T08:00:00Z</AiringTime>
                     <Duration>60</Duration>
                     <Color>Color</Color>
                     <AiringType>Unknown</AiringType>
                     <ShowingType>Unknown</ShowingType>
                     <CC>true</CC>
                     <LetterBox>false</LetterBox>
                     <Stereo>true</Stereo>
                     <HD>false</HD>
                     <SAP>false</SAP>
                     <TVRating>TV-PG</TVRating>
                     <Dolby>false</Dolby>
                     <DSS>false</DSS>
                     <HDLevel>HD Level Unknown</HDLevel>
                     <Sports>false</Sports>
                     <DVS>false</DVS>
                     <Category>Other</Category>
                     <Subcategory>sci-fi</Subcategory>
                     <SourceId>1280</SourceId>
                     <Channel>26</Channel>
                     <CallLetters>WGNAMER</CallLetters>
                     <SourceDisplayName>WGNAMER</SourceDisplayName>
                     <SourceLongName>WGN America</SourceLongName>
                     <TiVoSupported>true</TiVoSupported>
                     <ParentNetworkId>0</ParentNetworkId>
                     <IconAvailable>false</IconAvailable>
                     <ServiceId>360861</ServiceId>
                     <DvbTriplet/>
                     <SL>false</SL>
                     <Subtitles>false</Subtitles>
                  </ListingsAiring>
               </Airings>
            </Schedule>
            <Page>
               <PageSize>3</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>22</TotalRows>
               <SortByColumn>
                  <int>30</int>
                  <int>10</int>
               </SortByColumn>
            </Page>
            <UnsequencedEpisodePage>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>26</TotalRows>
            </UnsequencedEpisodePage>
         </GetProgramDetailsResult>
      </GetProgramDetailsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 3

Request IDs, images, and awards for the cast and crew of the TV series House.
  • Specify Credit in the MetaData element to return IDs and images of the cast and crew.
  • Specify Award in the MetaData element to return information about cast and crew awards and award nominations.
  • Specify the series ID in the ProgramHandle element (get program IDs from a GetGridSchedule or GetLinearSchedule response). Note: You could specify a program ID here instead to return data about the particular episode.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:lis="http://api.rovicorp.com/v9/listings">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <lis:GetProgramDetails>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ProgramHandle>
               <lis:Id>4180581</lis:Id>
               <lis:ProviderId>2</lis:ProviderId>
            </lis:ProgramHandle>
            <lis:MetaData>
               <lis:ProgramMetaData>Credit</lis:ProgramMetaData>
               <lis:ProgramMetaData>Award</lis:ProgramMetaData>
            </lis:MetaData>
            <lis:Format xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ServiceId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:InProgress xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:TitleType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:CopyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterAdultContents xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterCopyTextSource xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ImageCount>0</lis:ImageCount>
         </lis:request>
      </lis:GetProgramDetails>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length 35 ProgramCredit elements and 31 Award elements have been deleted.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetProgramDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetProgramDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">6f427c7f-09ac-4ef4-8faf-f2481cee075b</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T21:41:36.812Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T21:41:36.828Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Program DataAvailabilityFlags="0">
               <ProgramHandle>
                  <Id>4180581</Id>
                  <ProviderId>2</ProviderId>
               </ProgramHandle>
               <TvObjectId>0</TvObjectId>
               <MasterTitle/>
               <EpisodeTitle/>
               <CopyText/>
               <Runtime>0</Runtime>
               <ProgramType/>
               <Category/>
               <Subcategory/>
               <ReleaseYear>0</ReleaseYear>
               <Season/>
               <EpisodeNumber/>
               <PartNumber>0</PartNumber>
               <PartTotal>0</PartTotal>
               <StarRating>0</StarRating>
               <TVRating/>
               <MovieRating/>
               <Subtitled>false</Subtitled>
               <Letterbox>false</Letterbox>
               <CC>false</CC>
               <Color/>
               <OriginalAirDate xsi:nil="true"/>
               <Syndicated>false</Syndicated>
               <Keywords/>
               <Credits>
                  <ProgramCredit DataAvailabilityFlags="12">
                     <ProgramHandle>
                        <Id>4180581</Id>
                        <ProviderId>2</ProviderId>
                     </ProgramHandle>
                     <CreditHandle>
                        <Id>100609</Id>
                        <ProviderId>2</ProviderId>
                     </CreditHandle>
                     <CreditName>Hugh Laurie</CreditName>
                     <PartName>Dr. Greg House</PartName>
                     <CreditType>Actor</CreditType>
                     <Sequence>1</Sequence>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>1475501</ImageId>
                        <ImageTitle>Hugh Laurie</ImageTitle>
                        <ImageCaption>LOS ANGELES, CA - JANUARY 25: Actor Hugh Laurie arrives at the 15th Annual Screen Actors Guild Awards held at the Shrine Auditorium on January 25, 2009 in Los Angeles, California.</ImageCaption>
                        <ObjectId>100609</ObjectId>
                        <ObjectType>Credit</ObjectType>
                        <ObjectName>Hugh Laurie;Actor; Voice-overs</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCredit>Jason Merritt/Getty Images Entertainment/Getty Images</ImageCredit>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight>0</ImageCastWeight>
                        <ImageZoomLevel>1</ImageZoomLevel>
                        <ImageHeadcount>1</ImageHeadcount>
                        <ImageType>Celebrity</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>43</ImageHorizontalResolution>
                        <ImageVerticalResolution>60</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2010-02-22T11:24:02.843Z</LastUpdate>
                        <ImageFormatId>38</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>3:4</AspectRatio>
                        <ParentImageId>16859117</ParentImageId>
                        <MaxImageScale>1.97</MaxImageScale>
                     </Image>
                     <IsCelebrity>true</IsCelebrity>
                     <IsOrganization>false</IsOrganization>
                  </ProgramCredit>
                  <ProgramCredit DataAvailabilityFlags="12">
                     <ProgramHandle>
                        <Id>4180581</Id>
                        <ProviderId>2</ProviderId>
                     </ProgramHandle>
                     <CreditHandle>
                        <Id>100980</Id>
                        <ProviderId>2</ProviderId>
                     </CreditHandle>
                     <CreditName>Lisa Edelstein</CreditName>
                     <PartName>Dr. Lisa Cuddy</PartName>
                     <CreditType>Actor</CreditType>
                     <Sequence>2</Sequence>
                     <Image>
                        <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                        <ImageUseType xsi:nil="true"/>
                        <ImageId>1129687</ImageId>
                        <ImageTitle>Lisa Edelstein</ImageTitle>
                        <ImageCaption>BEVERLY HILLS, CA - OCTOBER 22: Actress Lisa Edelstein arrives at the Rodeo Drive Walk of Style Award honoring Princess Grace (Kelly) of Monaco and Cartier on October 22, 2009 in Beverly Hills, California.</ImageCaption>
                        <ObjectId>100980</ObjectId>
                        <ObjectType>Credit</ObjectType>
                        <ObjectName>Lisa Edelstein;Actor</ObjectName>
                        <Relevancy>true</Relevancy>
                        <ImageCredit>Alberto E. Rodriguez/Getty Images Entertainment/Getty Images</ImageCredit>
                        <ImageCreditDisplay xsi:nil="true"/>
                        <ImageCastWeight>0</ImageCastWeight>
                        <ImageZoomLevel>1</ImageZoomLevel>
                        <ImageHeadcount>1</ImageHeadcount>
                        <ImageType>Celebrity</ImageType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageHorizontalResolution>46</ImageHorizontalResolution>
                        <ImageVerticalResolution>60</ImageVerticalResolution>
                        <ImageMaintainAspectFlag xsi:nil="true"/>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2010-01-06T17:51:17.53Z</LastUpdate>
                        <ImageFormatId>38</ImageFormatId>
                        <Orientation>Portrait</Orientation>
                        <AspectRatio>3:4</AspectRatio>
                        <ParentImageId>16850045</ParentImageId>
                        <MaxImageScale>1.98</MaxImageScale>
                     </Image>
                     <IsCelebrity>true</IsCelebrity>
                     <IsOrganization>false</IsOrganization>
                  </ProgramCredit>
                  <ProgramCredit DataAvailabilityFlags="8">
                     <ProgramHandle>
                        <Id>4180581</Id>
                        <ProviderId>2</ProviderId>
                     </ProgramHandle>
                     <CreditHandle>
                        <Id>240794</Id>
                        <ProviderId>2</ProviderId>
                     </CreditHandle>
                     <CreditName>David Shore</CreditName>
                     <PartName/>
                     <CreditType>Creator</CreditType>
                     <Sequence>18</Sequence>
                     <IsCelebrity>false</IsCelebrity>
                     <IsOrganization>false</IsOrganization>
                  </ProgramCredit>               
               </Credits>
               <ProgramImages/>
               <IsVideoAvailable xsi:nil="true"/>
               <SeasonSequence xsi:nil="true"/>
               <SeriesSequence xsi:nil="true"/>
               <LastAirDate xsi:nil="true"/>
               <ParentalRatings/>
               <ProgramVariants/>
               <ProgramVideoClips/>
               <ProgramAwards>
                  <Award Title="House" Type="Emmy" Medium="TV" Category="Outstanding Lead Actor in a Drama Series" Year="2005" IsWinner="false" DataAvailabilityFlags="0">
                     <Recipients>
                        <Recipient FullName="Hugh Laurie" DataAvailabilityFlags="12">
                           <CreditHandle>
                              <Id>100609</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>true</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                     </Recipients>
                     <IsCelebrity>false</IsCelebrity>
                  </Award>
                  <Award Title="House" Type="Screen Actors Guild Awards" Medium="None" Category="Outstanding Performance by a Male Actor in a Drama Series" Year="2005" IsWinner="false" DataAvailabilityFlags="0">
                     <Recipients>
                        <Recipient FullName="Hugh Laurie" DataAvailabilityFlags="12">
                           <CreditHandle>
                              <Id>100609</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>true</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                     </Recipients>
                     <IsCelebrity>false</IsCelebrity>
                  </Award>
                  <Award Title="House" Type="Emmy" Medium="TV" Category="Outstanding Drama Series" Year="2006" IsWinner="false" DataAvailabilityFlags="0">
                     <Recipients>
                        <Recipient FullName="Bryan Singer" DataAvailabilityFlags="12">
                           <CreditHandle>
                              <Id>102173</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>true</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Matt Witten" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>124370</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Gerrit Van Der Meer" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>126514</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Katie Jacobs" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>151824</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Russel Friend" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>173617</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Garrett Lerner" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>187217</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="David Shore" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>240794</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Lawrence Kaplow" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>388766</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Paul Attanasio" DataAvailabilityFlags="12">
                           <CreditHandle>
                              <Id>392872</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="David Semel" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>429675</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Doris Egan" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>479351</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                        <Recipient FullName="Thomas L. Moran" DataAvailabilityFlags="8">
                           <CreditHandle>
                              <Id>544786</Id>
                              <ProviderId>2</ProviderId>
                           </CreditHandle>
                           <IsCelebrity>false</IsCelebrity>
                           <IsOrganization>false</IsOrganization>
                        </Recipient>
                     </Recipients>
                     <IsCelebrity>false</IsCelebrity>
                  </Award>
               </ProgramAwards>
               <ShowSeasons/>
               <UnsequencedEpisodes/>
               <Streamable xsi:nil="true"/>
            </Program>
            <Page>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>0</TotalRows>
            </Page>
            <UnsequencedEpisodePage>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>22</TotalRows>
            </UnsequencedEpisodePage>
         </GetProgramDetailsResult>
      </GetProgramDetailsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 4

Request information about the seasons of the TV series Castle in Spain.
  • Specify es-ES in the Locale element to return information that applies to Spain.
  • Specify Program in the MetaData element to return data about the series.
  • Specify SeasonWithoutEpisodes in the MetaData element to return data about the seasons.
  • Specify the series ID in the ProgramHandle element (get program IDs from a GetGridSchedule or GetLinearSchedule response.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://api.rovicorp.com/v9/common/types" xmlns:lis="http://api.rovicorp.com/v9/listings">
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <lis:GetProgramDetails>
         <lis:request>
            <lis:Locale>es-ES</lis:Locale>
            <lis:ProgramHandle>
               <lis:Id>9480826</lis:Id>
               <lis:ProviderId>2</lis:ProviderId>
            </lis:ProgramHandle>
            <lis:MetaData>
               <lis:ProgramMetaData>Program</lis:ProgramMetaData>
               <lis:ProgramMetaData>SeasonWithoutEpisodes</lis:ProgramMetaData>
            </lis:MetaData>
            <lis:Format xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ServiceId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:InProgress xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:TitleType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:CopyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterAdultContents xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:FilterCopyTextSource xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ImageCount>0</lis:ImageCount>
         </lis:request>
      </lis:GetProgramDetails>
   </soapenv:Body>
</soapenv:Envelope>

This request returns the following response.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetProgramDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetProgramDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">5f6087ad-a2f2-40e6-a76d-fe0bf8c1e45b</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T22:43:07.5Z</TimeStamp>
            <Status xmlns="http://api.rovicorp.com/v9/common/types">PNE</Status>
            <Errors xmlns="http://api.rovicorp.com/v9/common/types"/>
            <EndTimestamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T22:43:07.516Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Program DataAvailabilityFlags="470">
               <ProgramHandle>
                  <Id>15784538</Id>
                  <ProviderId>2</ProviderId>
               </ProgramHandle>
               <TvObjectId>0</TvObjectId>
               <MasterTitle>Castle</MasterTitle>
               <EpisodeTitle/>
               <CopyText>Un escritor de libros de misterio y asesinato trabaja junto a un policía para atrapar a un asesino en serie que recrea los crímenes de sus libros. Después de resolver ese caso, la pareja continúa trabajando para atrapar otros asesinos.</CopyText>
               <Runtime>58</Runtime>
               <ProgramType>Series</ProgramType>
               <Category>Other</Category>
               <Subcategory>crime drama</Subcategory>
               <ReleaseYear>0</ReleaseYear>
               <Season/>
               <EpisodeNumber/>
               <PartNumber>0</PartNumber>
               <PartTotal>0</PartTotal>
               <StarRating>0</StarRating>
               <TVRating>TV-PG</TVRating>
               <MovieRating/>
               <Subtitled>false</Subtitled>
               <Letterbox>false</Letterbox>
               <CC>true</CC>
               <Color>Color</Color>
               <OriginalAirDate xsi:nil="true"/>
               <Syndicated>false</Syndicated>
               <Keywords/>
               <Credits/>
               <ProgramImages/>
               <IsVideoAvailable xsi:nil="true"/>
               <SeasonSequence xsi:nil="true"/>
               <SeriesSequence xsi:nil="true"/>
               <LastAirDate xsi:nil="true"/>
               <CuttingPositions>
                  <int>98</int>
                  <int>107</int>
                  <int>146</int>
               </CuttingPositions>
               <ParentalRatings>
                  <ParentalRating>
                     <RatingType>FCTV</RatingType>
                     <Rating>13+</Rating>
                     <Reasons/>
                  </ParentalRating>
                  <ParentalRating>
                     <RatingType>Netherlands TV</RatingType>
                     <Rating>12</Rating>
                     <Reasons/>
                  </ParentalRating>
                  <ParentalRating>
                     <RatingType>Spain TV</RatingType>
                     <Rating>12</Rating>
                     <Reasons/>
                  </ParentalRating>
                  <ParentalRating>
                     <RatingType>US TV</RatingType>
                     <Rating>TV-PG</Rating>
                     <Reasons/>
                  </ParentalRating>
               </ParentalRatings>
               <ProgramVariants/>
               <ProgramVideoClips/>
               <ProgramAwards/>
               <ProgramLanguage>Spanish</ProgramLanguage>
               <CopyTextLanguage>Spanish</CopyTextLanguage>
               <ShowSeasons>
                  <TVSeason SeasonNumber="3" SeasonName="Season 3" SeasonYear="2010" SeasonEndYear="" TotalEpisodes="6">
                     <SeasonId>
                        <Id>18054775</Id>
                        <ProviderId>2</ProviderId>
                     </SeasonId>
                     <ShowEpisodes/>
                     <ParentalRatings/>
                     <AssociatedMedia/>
                     <Streamable>1</Streamable>
                  </TVSeason>
                  <TVSeason SeasonNumber="2" SeasonName="Season 2" SeasonYear="2009" SeasonEndYear="2010" TotalEpisodes="13">
                     <SeasonId>
                        <Id>15896586</Id>
                        <ProviderId>2</ProviderId>
                     </SeasonId>
                     <ShowEpisodes/>
                     <ParentalRatings/>
                     <AssociatedMedia/>
                     <Streamable>1</Streamable>
                  </TVSeason>
                  <TVSeason SeasonNumber="1" SeasonName="Season 1" SeasonYear="2009" SeasonEndYear="2009" TotalEpisodes="10">
                     <SeasonId>
                        <Id>15896585</Id>
                        <ProviderId>2</ProviderId>
                     </SeasonId>
                     <ShowEpisodes/>
                     <ParentalRatings/>
                     <AssociatedMedia/>
                     <Streamable>1</Streamable>
                  </TVSeason>
               </ShowSeasons>
               <UnsequencedEpisodes/>
               <Streamable>1</Streamable>
            </Program>
            <Page>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>0</TotalRows>
            </Page>
            <UnsequencedEpisodePage>
               <PageSize>0</PageSize>
               <StartIndex>0</StartIndex>
               <TotalRows>12</TotalRows>
            </UnsequencedEpisodePage>
         </GetProgramDetailsResult>
      </GetProgramDetailsResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

 
 
Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/V9.ListingsService:GetProgramDetailsExamples"
Personal tools