V9.ListingsService:GetGridScheduleExamples

Jump to: navigation, search

GetGridSchedule Request Examples

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

« GetGridSchedule

Request Example 1

Request the schedule for Time Warner Cable in Beverly Hills, California, over the next 60 minutes.

  • Specify en-US in the Locale element.
  • Specify 360861 in the ServiceId element, which was returned in a GetServices response.
  • Leave StartDate empty to let the starting time of the schedule be the time of the request.
  • Specify 60 in the Duration element, setting the number of minutes of schedule information to be returned.
  • Specify 3 in the TitleType element to limit titles to 8 characters.

<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:GetGridSchedule>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceId>360861</lis:ServiceId>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration>60</lis:Duration>
            <lis:TitleType>3</lis:TitleType>
            <lis:IncludeChannelImages xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ChannelImageCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </lis:request>
      </lis:GetGridSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length only 3 of the 67 GridChannel elements are shown.

<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>
      <GetGridScheduleResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetGridScheduleResult Locale="en-US" ServiceId="360861" Name="Beverly Hills - Time Warner Cable- Walnut/Diamond Bar" StartDate="2011-06-07T00:31:54.17946Z" Duration="60">
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">cf439e2f-283e-4ffd-a302-bb62f39a405c</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-07T00:31:54.179Z</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-07T00:31:54.195Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <TimeZones>
               <TimeZoneInfoGrid StartDateTime="2011-03-13T10:00:00Z" EndDateTime="2011-11-06T09:00:00Z" Offset="-420"/>
            </TimeZones>
            <GridChannels>
               <GridChannel ServiceId="360861" SourceId="696" Order="20448" Channel="2" CallLetters="KCBS" DisplayName="KCBS" SourceLongName="KCBS" Type="24-Hours" SourceType="Broadcast" ParentNetworkId="2" IconAvailable="true" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="5869363" Title="CBS News" AiringTime="2011-06-07T01:30:00Z" Duration="30" Color="Color" AiringType="New" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="None" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="19469100" SeriesId="667012" Title="ET" EpisodeTitle="MTV Movie Awards!" AiringTime="2011-06-07T02:00:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="TV-G" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="entertainment" Sports="false"/>
                     <GridAiring ProgramId="19480285" SeriesId="4251561" Title="Insider" EpisodeTitle="MTV Movie Awards!" AiringTime="2011-06-07T02:30:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="entertainment" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
               <GridChannel ServiceId="360861" SourceId="12013" Order="30449" Channel="3" CallLetters="TVGN" DisplayName="TVGN" SourceLongName="TV Guide Network (West)" Type="24-Hours" SourceType="Basic" ParentNetworkId="81" IconAvailable="true" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="7346641" SeriesId="5319036" Title="Hills" EpisodeTitle="When One Door Closes..." AiringTime="2011-06-07T01:30:00Z" Duration="30" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-PG" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="reality" Sports="false"/>
                     <GridAiring ProgramId="14333531" SeriesId="5319036" Title="Hills" EpisodeTitle="Paris Changes Everything" AiringTime="2011-06-07T02:00:00Z" Duration="30" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-PG" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="reality" Sports="false"/>
                     <GridAiring ProgramId="14333532" SeriesId="5319036" Title="Hills" EpisodeTitle="Paris Changes Everything" AiringTime="2011-06-07T02:30:00Z" Duration="30" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-PG" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="reality" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
               <GridChannel ServiceId="360861" SourceId="873" Order="40450" Channel="4" CallLetters="KNBC" DisplayName="KNBC" SourceLongName="KNBC" Type="24-Hours" SourceType="Broadcast" ParentNetworkId="5" IconAvailable="true" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="4350421" Title="News" AiringTime="2011-06-07T01:30:00Z" Duration="30" Color="Color" AiringType="New" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="None" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="19461733" SeriesId="4856" Title="Extra" AiringTime="2011-06-07T02:00:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-PG" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="entertainment" Sports="false"/>
                     <GridAiring ProgramId="19457753" SeriesId="894216" Title="ACCESS" AiringTime="2011-06-07T02:30:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-G" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="entertainment" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
         </GetGridScheduleResult>
      </GetGridScheduleResponse>
   </soap:Body>
</soap:Envelope>

Request Example 2

Request a schedule with channel logos for CanalSat in Paris, France, over the next 60 minutes.
  • Specify fr-FR in the Locale element.
  • Specify 890504 in the ServiceId element, which was returned in a GetServices response.
  • Leave StartDate empty to let the starting time of the schedule be the time of the request.
  • Specify 60 in the Duration element, setting the number of minutes of schedule information to be returned.
  • Specify 1 in the TitleType element to limit titles to 15 characters.
  • Specify a value of true in the IncludeChannelImages element to include channel images.
  • Specify 54 in the ImageFormatId element to return JPG images that fit a bounding box of 40 by 60 pixels on one or both sides.
  • Leave ChannelImageCount empty to let the number of images returned for a channel default to one.
<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:GetGridSchedule>
         <lis:request>
            <lis:Locale>fr-FR</lis:Locale>
            <lis:ServiceId>890504</lis:ServiceId>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration>60</lis:Duration>
            <lis:TitleType>1</lis:TitleType>
            <lis:IncludeChannelImages>true</lis:IncludeChannelImages>
            <lis:ImageFilter>
               <lis:ImageFormatId>54</lis:ImageFormatId>
            </lis:ImageFilter>
            <lis:ChannelImageCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </lis:request>
      </lis:GetGridSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length only 2 of the 120 GridChannel elements are shown.

<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>
      <GetGridScheduleResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetGridScheduleResult Locale="fr-FR" ServiceId="890504" Name="CanalSat with France Area Channels (Central Europe)" StartDate="2011-06-07T01:07:10.6344278Z" Duration="60">
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">6460b7c8-430a-4cd8-8cf0-1b606d89d3f0</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-07T01:07:10.634Z</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-07T01:07:10.696Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <TimeZones>
               <TimeZoneInfoGrid StartDateTime="2011-03-27T01:00:00Z" EndDateTime="2011-10-30T00:00:00Z" Offset="120"/>
            </TimeZones>
            <GridChannels>
               <GridChannel ServiceId="890504" SourceId="26492" Order="10140" Channel="1" CallLetters="TF1" DisplayName="TF1" SourceLongName="TF1" Type="24-Hours" SourceType="Broadcast" ParentNetworkId="0" IconAvailable="false" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="15386377" Title="Sept à Huit" AiringTime="2011-06-07T00:45:00Z" Duration="100" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="magazine" Sports="false"/>
                     <GridAiring ProgramId="2526609" Title="Tous ensemble" AiringTime="2011-06-07T02:25:00Z" Duration="40" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="entertainment" Sports="false"/>
                  </Airings>
                  <ChannelImages>
                     <ImageGrid ImageUrl="http://actual-url-concealed.jpg" ImageId="2006576" ImageTitle="TF1" ImageCaption="EU source logo" ObjectId="26492" ObjectName="TF1" ImageCreditDisplay="false" ImageType="Station Logo" ImageHorizontalResolution="40" ImageVerticalResolution="15" ImageFormatId="54" AspectRatio="5:2" ParentImageId="16866071">
                        <ObjectType>Source</ObjectType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2010-04-13T16:58:32.533Z</LastUpdate>
                     </ImageGrid>
                  </ChannelImages>
               </GridChannel>
               <GridChannel ServiceId="890504" SourceId="24801" Order="20141" Channel="2" CallLetters="AN2" DisplayName="AN2" SourceLongName="France 2" Type="24-Hours" SourceType="Broadcast" ParentNetworkId="0" IconAvailable="false" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="15082502" Title="24 heures d'inf" AiringTime="2011-06-07T01:30:00Z" Duration="13" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="Tous" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="15311355" Title="Météo 2" AiringTime="2011-06-07T01:43:00Z" Duration="2" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="15356201" Title="Profession rech" AiringTime="2011-06-07T01:45:00Z" Duration="25" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="documentary" Sports="false"/>
                     <GridAiring ProgramId="15563952" Title="Courant d'art" AiringTime="2011-06-07T02:10:00Z" Duration="10" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Lifestyle" Subcategory="arts &amp; literature" Sports="false"/>
                     <GridAiring ProgramId="15160669" Title="Dans le secret" AiringTime="2011-06-07T02:20:00Z" Duration="65" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="documentary" Sports="false"/>
                  </Airings>
                  <ChannelImages>
                     <ImageGrid ImageUrl="actual-url-concealed" ImageId="2006596" ImageTitle="France 2" ImageCaption="EU source logo" ObjectId="24801" ObjectName="France 2" ImageCreditDisplay="false" ImageType="Station Logo" ImageHorizontalResolution="40" ImageVerticalResolution="15" ImageFormatId="54" AspectRatio="5:2" ParentImageId="16867785">
                        <ObjectType>Source</ObjectType>
                        <ImageFormat>jpg</ImageFormat>
                        <ImageExpiryDateTime xsi:nil="true"/>
                        <LastUpdate>2010-04-26T17:04:52.533Z</LastUpdate>
                     </ImageGrid>
                  </ChannelImages>
               </GridChannel>
             </GridChannels>
         </GetGridScheduleResult>
      </GetGridScheduleResponse>
   </soap:Body>
</soap:Envelope>

Request Example 3

Request the schedule for Time Warner in southern Manhattan starting on Thursday night at 8:00.
  • Specify en-US in the Locale element.
  • Specify 60795 in the ServiceId element, which was returned in a GetServices response.
  • Set the starting date and time in the StartDate element.
  • Specify 120 in the Duration element, setting the number of minutes of schedule information to be returned.
  • Specify 1 in the TitleType element to limit titles to 15 characters.
<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:GetGridSchedule>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceId>60795</lis:ServiceId>
            <lis:StartDate>2011-06-09T20:00:00.000-04:00</lis:StartDate>
            <lis:Duration>120</lis:Duration>
            <lis:TitleType>1</lis:TitleType>
            <lis:IncludeChannelImages xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ChannelImageCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </lis:request>
      </lis:GetGridSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length only 2 of the 120 GridChannel elements are shown.

<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>
      <GetGridScheduleResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetGridScheduleResult Locale="en-US" ServiceId="60795" Name="Southern Manhattan - Time Warner" StartDate="2011-06-10T00:00:00Z" Duration="120">
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">ae159d0a-3cdf-41ef-8bcc-5851ea3d9877</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-07T22:02:27.983Z</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-07T22:02:29.249Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <TimeZones>
               <TimeZoneInfoGrid StartDateTime="2011-03-13T07:00:00Z" EndDateTime="2011-11-06T06:00:00Z" Offset="-240"/>
            </TimeZones>
            <GridChannels>
               <GridChannel ServiceId="60795" SourceId="1991" Order="10019" Channel="1" CallLetters="NY1NEW" DisplayName="NY1NEW" SourceLongName="New York 1 News" Type="24-Hours" SourceType="Basic" ParentNetworkId="0" IconAvailable="false" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="3309930" Title="New York Tonite" AiringTime="2011-06-10T00:00:00Z" Duration="60" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="4826203" Title="The Call" AiringTime="2011-06-10T01:00:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="public affairs" Sports="false"/>
                     <GridAiring ProgramId="4321327" Title="News Eve" AiringTime="2011-06-10T01:30:00Z" Duration="30" Color="Color" AiringType="New" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="News" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="811241" Title="Inside City Hll" AiringTime="2011-06-10T02:00:00Z" Duration="60" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
               <GridChannel ServiceId="60795" SourceId="102" Order="20039" Channel="2" CallLetters="WCBS" DisplayName="WCBS" SourceLongName="WCBS" Type="24-Hours" SourceType="Broadcast" ParentNetworkId="2" IconAvailable="true" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="18446347" SeriesId="6718065" Title="Big Bang Theory" EpisodeTitle="The Desperation Emanation" AiringTime="2011-06-10T00:00:00Z" Duration="31" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-14@DL" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="comedy" Sports="false"/>
                     <GridAiring ProgramId="18795316" SeriesId="6227035" Title="Rules/Engagemnt" EpisodeTitle="Refusing to Budget" AiringTime="2011-06-10T00:31:00Z" Duration="29" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-14@DL" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="comedy" Sports="false"/>
                     <GridAiring ProgramId="18514094" SeriesId="2545072" Title="CSI: Crime" EpisodeTitle="Cold Blooded" AiringTime="2011-06-10T01:00:00Z" Duration="60" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-14@V" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="crime drama" Sports="false"/>
                     <GridAiring ProgramId="18795470" SeriesId="7944533" Title="The Mentalist" EpisodeTitle="A Jolly Red Elf" AiringTime="2011-06-10T02:00:00Z" Duration="60" Color="Color" AiringType="Repeat" CC="true" LetterBox="false" Stereo="true" HD="false" SAP="false" TVRating="TV-14@LV" Dolby="true" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Other" Subcategory="crime drama" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
            </GridChannels>
         </GetGridScheduleResult>
      </GetGridScheduleResponse>
   </soap:Body>
</soap:Envelope>

Request Example 4

Request a schedule starting at 8:00 PM for the sports stations on Time Warner in southern Manhattan, except for the Pay-Per-View stations.
  • Specify en-US in the Locale element.
  • Specify 60795 in the ServiceId element, which was returned in a GetServices response.
  • Set the starting date and time in the StartDate element.
  • Specify 240 in the Duration element, setting the number of minutes of schedule information to be returned.
  • Specify the source IDs of the sports stations in a Sources element.
  • Specify PPV in an Excludes element.
  • Specify 1 in the TitleType element to limit titles to 15 characters.
<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:GetGridSchedule>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceId>60795</lis:ServiceId>
            <lis:StartDate>2011-06-08T20:00:00.000-04:00</lis:StartDate>
            <lis:Duration>240</lis:Duration>
            <lis:SourceFilter>
               <lis:Sources>
                  <lis:SourceId>423</lis:SourceId>
                  <lis:SourceId>1219</lis:SourceId>
                  <lis:SourceId>6191</lis:SourceId>
                  <lis:SourceId>8272</lis:SourceId>
                  <lis:SourceId>8274</lis:SourceId>
                  <lis:SourceId>8276</lis:SourceId>
                  <lis:SourceId>8277</lis:SourceId>
                  <lis:SourceId>8278</lis:SourceId>
                  <lis:SourceId>8279</lis:SourceId>
                  <lis:SourceId>8753</lis:SourceId>
                  <lis:SourceId>10335</lis:SourceId>
                  <lis:SourceId>10395</lis:SourceId>
                  <lis:SourceId>10639</lis:SourceId>
                  <lis:SourceId>12206</lis:SourceId>
                  <lis:SourceId>12280</lis:SourceId>
                  <lis:SourceId>12695</lis:SourceId>
                  <lis:SourceId>15169</lis:SourceId>
                  <lis:SourceId>16036</lis:SourceId>
                  <lis:SourceId>16261</lis:SourceId>
                  <lis:SourceId>17094</lis:SourceId>
                  <lis:SourceId>17186</lis:SourceId>
                  <lis:SourceId>18729</lis:SourceId>
                  <lis:SourceId>18735</lis:SourceId>
                  <lis:SourceId>18736</lis:SourceId>
                  <lis:SourceId>18737</lis:SourceId>
                  <lis:SourceId>18738</lis:SourceId>
                  <lis:SourceId>20735</lis:SourceId>
                  <lis:SourceId>27235</lis:SourceId>
                  <lis:SourceId>60795</lis:SourceId>
               </lis:Sources>
               <lis:Excludes>
                  <lis:Exclude>PPV</lis:Exclude>
               </lis:Excludes>
            </lis:SourceFilter>
            <lis:TitleType>1</lis:TitleType>
            <lis:IncludeChannelImages xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:ChannelImageCount xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
         </lis:request>
      </lis:GetGridSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length only the first 2 of the 30 GridChannel elements are shown.

<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>
      <GetGridScheduleResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetGridScheduleResult Locale="en-US" ServiceId="60795" Name="Southern Manhattan - Time Warner" StartDate="2011-06-09T00:00:00Z" Duration="240">
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">38797bbc-499d-4f88-a851-b0c65e8fb874</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-08T22:02:33.191Z</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-08T22:02:33.238Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <TimeZones>
               <TimeZoneInfoGrid StartDateTime="2011-03-13T07:00:00Z" EndDateTime="2011-11-06T06:00:00Z" Offset="-240"/>
            </TimeZones>
            <GridChannels>
               <GridChannel ServiceId="60795" SourceId="17094" Order="260072" Channel="26" CallLetters="SNY" DisplayName="SNY" SourceLongName="SportsNet New York" Type="24-Hours" SourceType="Basic" ParentNetworkId="0" IconAvailable="false" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="1180400" Title="MLB Baseball" AiringTime="2011-06-09T00:00:00Z" Duration="180" Color="Color" AiringType="Live" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="baseball" Sports="true"/>
                     <GridAiring ProgramId="5334983" Title="Postgame Live" AiringTime="2011-06-09T03:00:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="baseball" Sports="false"/>
                     <GridAiring ProgramId="5334982" Title="SportsNite" AiringTime="2011-06-09T03:30:00Z" Duration="30" Color="Color" AiringType="New" CC="false" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="5334982" Title="SportsNite" AiringTime="2011-06-09T04:00:00Z" Duration="30" Color="Color" AiringType="Unknown" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="newscast" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
               <GridChannel ServiceId="60795" SourceId="423" Order="280074" Channel="28" CallLetters="ESPN" DisplayName="ESPN" SourceLongName="ESPN" Type="24-Hours" SourceType="Basic" ParentNetworkId="60" IconAvailable="true" IsChannelOverride="false">
                  <ChannelSchedules/>
                  <SourceAttributeTypes/>
                  <Airings>
                     <GridAiring ProgramId="1166213" Title="MLB Baseball" AiringTime="2011-06-08T23:00:00Z" Duration="180" Color="Color" AiringType="Live" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="baseball" Sports="true"/>
                     <GridAiring ProgramId="825506" Title="Base. Tonight" AiringTime="2011-06-09T02:00:00Z" Duration="60" Color="Color" AiringType="New" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="baseball" Sports="false"/>
                     <GridAiring ProgramId="988429" Title="SportsCenter" AiringTime="2011-06-09T03:00:00Z" Duration="60" Color="Color" AiringType="New" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="newscast" Sports="false"/>
                     <GridAiring ProgramId="825506" Title="Base. Tonight" AiringTime="2011-06-09T04:00:00Z" Duration="30" Color="Color" AiringType="New" CC="true" LetterBox="false" Stereo="false" HD="false" SAP="false" TVRating="None" Dolby="false" DSS="false" HDLevel="HD Level Unknown" DVS="false" Category="Sports" Subcategory="baseball" Sports="false"/>
                  </Airings>
                  <ChannelImages/>
               </GridChannel>
            </GridChannels>
         </GetGridScheduleResult>
      </GetGridScheduleResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

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