V9.ListingsService:GetServicesExamples

Jump to: navigation, search

GetServices Request Examples

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

« GetServices

Request Example 1

Request the television service offerings for Beverly Hills 90210.

  • Specify en-US in the Locale element as the language and country code.
  • Specify 90210 in the PostalCode element.
  • Specify US in the CountryCode element.
  • Specify 263520 in the Duration element to see the UTC offsets that apply to the service providers during the next six months.

<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:GetServices>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceSearch>
               <lis:PostalCode>90210</lis:PostalCode>
               <lis:CountryCode>US</lis:CountryCode>
            </lis:ServiceSearch>            
            <lis:StartDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <lis:Duration>263520</lis:Duration>
         </lis:request>
      </lis:GetServices>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length ten Service 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>
      <GetServicesResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServicesResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">471bd2cf-ca42-4ba3-8db5-45ea9fdfde59</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T23:16:56.942Z</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-03T23:16:56.942Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Services>
               <Service>
                  <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>
                  <SystemName>Broadcast TV</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                        <Offset>-420</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <ServiceId>200753</ServiceId>
                  <Name>Beverly Hills - WSNET - Mulholland Est</Name>
                  <City>Beverly Hills</City>
                  <Type>Cable</Type>
                  <MSO>WSNET</MSO>
                  <MSOID>1004</MSOID>
                  <SystemName>WSNET - Mulholland Estates</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                        <Offset>-420</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <ServiceId>61616</ServiceId>
                  <Name>C-Band (Pacific)</Name>
                  <City>C-Band Pacific Time</City>
                  <Type>Satellite</Type>
                  <MSO>Data Services Product</MSO>
                  <MSOID>301530</MSOID>
                  <SystemName>C-Band Providers</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                        <Offset>-420</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <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>
                  <SystemName>Time Warner Cable- Walnut/Diamond Bar</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                        <Offset>-420</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
            </Services>
         </GetServicesResult>
      </GetServicesResponse>
   </soap:Body>
</soap:Envelope>

Request Example 2

Request the television service offerings for Moose Jaw, Saskatchewan S6H 2X1.
  • Specify en-CA in the Locale element as the language and country code.
  • Specify S6H 2X1 in the PostalCode element. Note the space.
  • Specify CA in the CountryCode element.
<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:GetServices>
         <lis:request>
            <lis:Locale>en-CA</lis:Locale>
            <lis:ServiceSearch>
               <lis:PostalCode>90210</lis:PostalCode>
               <lis:CountryCode>US</lis:CountryCode>
            </lis:ServiceSearch>            
            <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:request>
      </lis:GetServices>
   </soapenv:Body>
</soapenv:Envelope>

Here's the response to this request, but to reduce the length four Service 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>
      <GetServicesResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServicesResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">581622b0-4f57-486f-b7f4-8c50b0b99037</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-03T23:29:13.913Z</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-03T23:29:13.913Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Services>
               <Service>
                  <ServiceId>890113</ServiceId>
                  <Name>Regina - SaskTel Max</Name>
                  <City>Regina</City>
                  <Type>Cable</Type>
                  <MSO>SaskTel Max</MSO>
                  <MSOID>305280</MSOID>
                  <SystemName>SaskTel Max</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-01-01T06:00:00Z</StartDateTime>
                        <EndDateTime>2012-01-01T06:00:00Z</EndDateTime>
                        <Offset>-360</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <ServiceId>82908</ServiceId>
                  <Name>Saskatchewan Area Channels - Broadcast TV</Name>
                  <City>Saskatchewan</City>
                  <Type>Broadcast</Type>
                  <MSO>Data Services Product</MSO>
                  <MSOID>301530</MSOID>
                  <SystemName>Broadcast TV - Canada</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-01-01T06:00:00Z</StartDateTime>
                        <EndDateTime>2012-01-01T06:00:00Z</EndDateTime>
                        <Offset>-360</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <ServiceId>889977</ServiceId>
                  <Name>Shaw Direct Advanced (Pacific)</Name>
                  <City>Pacific Time Zone</City>
                  <Type>Satellite</Type>
                  <MSO>Shaw Direct</MSO>
                  <MSOID>300513</MSOID>
                  <SystemName>Shaw Direct Advanced</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T10:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T09:00:00Z</EndDateTime>
                        <Offset>-420</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
            </Services>
         </GetServicesResult>
      </GetServicesResponse>
   </soap:Body>
</soap:Envelope>

Request Example 3

Request the Time Warner Cable offerings for New York, New York 10020.
  • Specify en-US in the Locale element as the language and country code.
  • Specify 10020 in the PostalCode element.
  • Specify US in the CountryCode element.
  • Specify 25 in the MSOId element to return just Time Warner Cable service providers. Note: to get the MSOId of a service provider, make a GetServices request in an area supplied by the service provider.
<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:GetServices>
         <lis:request>
            <lis:Locale>en-US</lis:Locale>
            <lis:ServiceSearch>
               <lis:PostalCode>90210</lis:PostalCode>
               <lis:CountryCode>US</lis:CountryCode>
               <lis:MSOId>25</lis:MSOId>
            </lis:ServiceSearch>            
            <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:request>
      </lis:GetServices>
   </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>
      <GetServicesResponse xmlns="http://api.rovicorp.com/v9/listings">
         <GetServicesResult>
            <RequestId xmlns="http://api.rovicorp.com/v9/common/types">a18a019e-0670-4ebe-be0d-5d08ffc38389</RequestId>
            <TimeStamp xmlns="http://api.rovicorp.com/v9/common/types">2011-06-04T00:02:46.704Z</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-04T00:02:46.704Z</EndTimestamp>
            <Build xmlns="http://api.rovicorp.com/v9/common/types">CPS Phase v9 Build 9.5.1.8</Build>
            <Services>
               <Service>
                  <ServiceId>60795</ServiceId>
                  <Name>Southern Manhattan - Time Warner</Name>
                  <City>Southern Manhattan</City>
                  <Type>Cable</Type>
                  <MSO>Time Warner Cable</MSO>
                  <MSOID>25</MSOID>
                  <SystemName>Time Warner Cable</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T07:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T06:00:00Z</EndDateTime>
                        <Offset>-240</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
               <Service>
                  <ServiceId>60772</ServiceId>
                  <Name>Manhattan - Time Warner Cable - Northern Manhattan</Name>
                  <City>Manhattan</City>
                  <Type>Cable</Type>
                  <MSO>Time Warner Cable</MSO>
                  <MSOID>25</MSOID>
                  <SystemName>Time Warner Cable</SystemName>
                  <TimeZones>
                     <TimeZoneInfo>
                        <StartDateTime>2011-03-13T07:00:00Z</StartDateTime>
                        <EndDateTime>2011-11-06T06:00:00Z</EndDateTime>
                        <Offset>-240</Offset>
                     </TimeZoneInfo>
                  </TimeZones>
               </Service>
            </Services>
         </GetServicesResult>
      </GetServicesResponse>
   </soap:Body>
</soap:Envelope>

See Also

↑ Top

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