V9.ListingsService:GetServiceDetailsExamples

Jump to: navigation, search

GetServiceDetails Request Examples

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

« GetServiceDetails

Request Example 1

Request the channel lineup for Time Warner Cable in Beverly Hills, California.

  • Specify en-US in the Locale element.
  • Specify 360861 in the ServiceId element, which was returned in a GetServices response.
  • Leave StartDate and Duration empty to see the UTC offsets that apply to the service provider for at least the next two weeks.

<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:GetServiceDetails>
         <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 xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:IncludeChannelImages 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:GetServiceDetails>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length 64 ListingsChannel 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>
      <GetServiceDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServiceDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">43a821fd-6834-4cbc-a430-80840638be7d</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-06T21:27:42.807Z</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-06T21:27:42.807Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <ChannelLineup>
               <ServiceId>360861</ServiceId>
               <Name>Beverly Hills - Time Warner Cable- Walnut/Diamond Bar</Name>
               <City>Beverly Hills</City>
               <Type>Cable</Type>
               <MSO>Time Warner Cable</MSO>
               <MSOID>25</MSOID>
               <TimeZones>
                  <TimeZoneInfo>
                     <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                     <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                     <Offset>-420</Offset>
                  </TimeZoneInfo>
               </TimeZones>
               <Channels>
                  <ListingsChannel SourceId="696" Channel="2" CallLetters="KCBS" DisplayName="KCBS" SourceType="Broadcast" Type="24-Hours" Order="1" TiVoSupported="true" ParentNetworkId="2" IconAvailable="true" FullName="KCBS" VirtualChannelNumber="" Affiliation="2165" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
                  <ListingsChannel SourceId="12013" Channel="3" CallLetters="TVGN" DisplayName="TVGN" SourceType="Basic" Type="24-Hours" Order="2" TiVoSupported="true" ParentNetworkId="81" IconAvailable="true" FullName="TV Guide Network (West)" VirtualChannelNumber="" Affiliation="0" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
                  <ListingsChannel SourceId="873" Channel="4" CallLetters="KNBC" DisplayName="KNBC" SourceType="Broadcast" Type="24-Hours" Order="3" TiVoSupported="true" ParentNetworkId="5" IconAvailable="true" FullName="KNBC" VirtualChannelNumber="" Affiliation="1209" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
               </Channels>
            </ChannelLineup>
         </GetServiceDetailsResult>
      </GetServiceDetailsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 2

Request the channel lineup for Los Angeles area broadcast channels in Pasadena, California, along with small channel logos.
  • Specify en-US in the Locale element.
  • Specify 20494 in the ServiceId element, which was returned in a GetServices response.
  • Leave StartDate and Duration empty to see the UTC offsets that apply to the service provider for at least the next two weeks.
  • Specify a value of true for the IncludeChannelImages element.
  • 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.
  • Specify 2 in the ImageCount element to return two images for each channel, if available.
<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:GetServiceDetails>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceId>20494</lis:ServiceId>
            <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:IncludeChannelImages>true</lis:IncludeChannelImages>
            <lis:ImageFilter>
               <lis:ImageFormatId>54</lis:ImageFormatId>
            </lis:ImageFilter>
            <lis:ImageCount>2</lis:ImageCount>
         </lis:request>
      </lis:GetServiceDetails>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length 94 ListingsChannel 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>
      <GetServiceDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServiceDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">18654c46-7ddd-4b4d-b010-2d06e8ca1266</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-06T23:29:54.265Z</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-06T23:29:54.281Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <ChannelLineup>
               <ServiceId>20494</ServiceId>
               <Name>Los Angeles Area Channels - Los Angeles Area Broadcast</Name>
               <City>Los Angeles</City>
               <Type>Broadcast</Type>
               <MSO>Data Services Product</MSO>
               <MSOID>301530</MSOID>
               <TimeZones>
                  <TimeZoneInfo>
                     <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                     <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                     <Offset>-420</Offset>
                  </TimeZoneInfo>
               </TimeZones>
               <Channels>
                  <ListingsChannel SourceId="11110" Channel="2.1" CallLetters="KCBSHD" DisplayName="KCBSHD" SourceType="Broadcast" Type="24-Hours" Order="1" TiVoSupported="true" ParentNetworkId="2" IconAvailable="true" FullName="KCBS HDTV" VirtualChannelNumber="2.1" Affiliation="2165" ServiceType="Digital">
                     <ChannelSchedules/>
                     <SourceAttributeTypes>
                        <SourceAttributeType>HD</SourceAttributeType>
                     </SourceAttributeTypes>
                     <ChannelImages>
                        <Image>
                           <ImageUrl>http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>1862657</ImageId>
                           <ImageTitle>CBS</ImageTitle>
                           <ImageCaption>Widget Logo</ImageCaption>
                           <ObjectId>11110</ObjectId>
                           <ObjectType>Source</ObjectType>
                           <ObjectName>KCBS HDTV</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight xsi:nil="true"/>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount xsi:nil="true"/>
                           <ImageType>Station Logo</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>40</ImageHorizontalResolution>
                           <ImageVerticalResolution>15</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2009-03-03T14:55:51.283Z</LastUpdate>
                           <ImageFormatId>54</ImageFormatId>
                           <Orientation>Landscape</Orientation>
                           <AspectRatio>5:2</AspectRatio>
                           <ParentImageId>16814157</ParentImageId>
                           <MaxImageScale>43.48</MaxImageScale>
                        </Image>
                        <Image>
                           <ImageUrl>http://http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>2004226</ImageId>
                           <ImageTitle>CBS</ImageTitle>
                           <ImageCaption>Source Logo</ImageCaption>
                           <ObjectId>11110</ObjectId>
                           <ObjectType>Source</ObjectType>
                           <ObjectName>CBS; CBS</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCredit>CBS</ImageCredit>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight xsi:nil="true"/>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount xsi:nil="true"/>
                           <ImageType>Station Logo</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>40</ImageHorizontalResolution>
                           <ImageVerticalResolution>11</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2009-02-05T10:13:13.4Z</LastUpdate>
                           <ImageFormatId>54</ImageFormatId>
                           <Orientation>Landscape</Orientation>
                           <AspectRatio>7:2</AspectRatio>
                           <ImageOwner>CBS</ImageOwner>
                           <ParentImageId>16786821</ParentImageId>
                           <MaxImageScale>4.42</MaxImageScale>
                        </Image>
                     </ChannelImages>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
                  <ListingsChannel SourceId="11287" Channel="4.1" CallLetters="KNBCHD" DisplayName="KNBCHD" SourceType="Broadcast" Type="24-Hours" Order="2" TiVoSupported="true" ParentNetworkId="5" IconAvailable="true" FullName="KNBC HDTV" VirtualChannelNumber="4.1" Affiliation="1209" ServiceType="Digital">
                     <ChannelSchedules/>
                     <SourceAttributeTypes>
                        <SourceAttributeType>HD</SourceAttributeType>
                     </SourceAttributeTypes>
                     <ChannelImages>
                        <Image>
                           <ImageUrl>http://http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>1862562</ImageId>
                           <ImageTitle>NBC</ImageTitle>
                           <ImageCaption>Source logo</ImageCaption>
                           <ObjectId>11287</ObjectId>
                           <ObjectType>Source</ObjectType>
                           <ObjectName>NBC; National Broadcast Company</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCredit>NBC</ImageCredit>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight xsi:nil="true"/>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount xsi:nil="true"/>
                           <ImageType>Station Logo</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>40</ImageHorizontalResolution>
                           <ImageVerticalResolution>38</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2008-08-18T15:00:28.81Z</LastUpdate>
                           <ImageFormatId>54</ImageFormatId>
                           <Orientation>Landscape</Orientation>
                           <AspectRatio>1:1</AspectRatio>
                           <ImageOwner>NBC</ImageOwner>
                           <ParentImageId>16777425</ParentImageId>
                           <MaxImageScale>2</MaxImageScale>
                        </Image>
                        <Image>
                           <ImageUrl>http://http://actual-url-concealed.jpg</ImageUrl>
                           <ImageUseType xsi:nil="true"/>
                           <ImageId>1862659</ImageId>
                           <ImageTitle>NBC</ImageTitle>
                           <ImageCaption>Widget Logo</ImageCaption>
                           <ObjectId>11287</ObjectId>
                           <ObjectType>Source</ObjectType>
                           <ObjectName>KNBC HDTV</ObjectName>
                           <Relevancy>true</Relevancy>
                           <ImageCreditDisplay xsi:nil="true"/>
                           <ImageCastWeight xsi:nil="true"/>
                           <ImageZoomLevel>1</ImageZoomLevel>
                           <ImageHeadcount xsi:nil="true"/>
                           <ImageType>Station Logo</ImageType>
                           <ImageFormat>jpg</ImageFormat>
                           <ImageHorizontalResolution>40</ImageHorizontalResolution>
                           <ImageVerticalResolution>15</ImageVerticalResolution>
                           <ImageMaintainAspectFlag xsi:nil="true"/>
                           <ImageExpiryDateTime xsi:nil="true"/>
                           <LastUpdate>2009-03-03T14:56:24.11Z</LastUpdate>
                           <ImageFormatId>54</ImageFormatId>
                           <Orientation>Landscape</Orientation>
                           <AspectRatio>5:2</AspectRatio>
                           <ParentImageId>16814160</ParentImageId>
                           <MaxImageScale>43.48</MaxImageScale>
                        </Image>
                     </ChannelImages>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
               </Channels>
            </ChannelLineup>
         </GetServiceDetailsResult>
      </GetServiceDetailsResponse>
   </soap:Body>
</soap:Envelope>

Request Example 3

Request the channel lineup for Shaw Cable in Moose Jaw, Saskatchewan, and the UTC offsets for the next six months.
  • Specify en-CA in the Locale element.
  • Specify 68809 in the ServiceId element, which was returned in a GetServices response.
  • Specify a Duration of 263520 and leave StartDate empty to see the UTC offsets that apply to the service provider for at least the next six months.
   <soapenv:Header>
      <typ:AuthHeader>
         <typ:UserName>username</typ:UserName>
         <typ:Password>password</typ:Password>
      </typ:AuthHeader>
   </soapenv:Header>
   <soapenv:Body>
      <lis:GetServiceDetails>
         <lis:request>
            <lis:Locale>en-CA</lis:Locale>
            <lis:ServiceId>68809</lis:ServiceId>
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration>263520</lis:Duration>
            <lis:IncludeChannelImages 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:GetServiceDetails>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length 216 ListingsChannel 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>
      <GetServiceDetailsResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServiceDetailsResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">6b030c91-3e23-46e7-8e11-3bf770ce042a</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-07T00:00:52.4Z</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:00:52.4Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <ChannelLineup>
               <ServiceId>68809</ServiceId>
               <Name>Moose Jaw - Shaw Cable</Name>
               <City>Moose Jaw</City>
               <Type>Cable</Type>
               <MSO>Shaw Communications, Inc.</MSO>
               <MSOID>693</MSOID>
               <TimeZones>
                  <TimeZoneInfo>
                     <StartDateTime>2011-01-01T08:00:00Z</StartDateTime>
                     <EndDateTime>2012-01-01T08:00:00Z</EndDateTime>
                     <Offset>-480</Offset>
                  </TimeZoneInfo>
               </TimeZones>
               <Channels>
                  <ListingsChannel SourceId="2666" Channel="2" CallLetters="WTVS" DisplayName="WTVS" SourceType="Broadcast" Type="24-Hours" Order="1" TiVoSupported="true" ParentNetworkId="7" IconAvailable="true" FullName="WTVS" VirtualChannelNumber="" Affiliation="2164" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
                  <ListingsChannel SourceId="5615" Channel="3" CallLetters="CBKFT" DisplayName="CBKFT" SourceType="Broadcast" Type="24-Hours" Order="2" TiVoSupported="true" ParentNetworkId="0" IconAvailable="false" FullName="Radio-Canada Saskatchewan (Regina)" VirtualChannelNumber="" Affiliation="3085" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
                  <ListingsChannel SourceId="4535" Channel="4" CallLetters="TVL" DisplayName="TVL" SourceType="Basic" Type="24-Hours" Order="3" TiVoSupported="true" ParentNetworkId="0" IconAvailable="false" FullName="TV Listings" Affiliation="0" ServiceType="Analog">
                     <ChannelSchedules/>
                     <SourceAttributeTypes/>
                     <ChannelImages/>
                     <ChannelLocation/>
                     <DvbTriplets/>
                  </ListingsChannel>
               </Channels>
            </ChannelLineup>
         </GetServiceDetailsResult>
      </GetServiceDetailsResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

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