V9.Common:GetServicesSearch

Jump to: navigation, search

GetServicesSearch

Contains information needed to return a list of television services.
For a Locale in Canada or the United States, provide a postal code within the service area:
  • For locales in the United States (en-US, es-US), provide five digits in the range of 00501 to 99950.
  • For locales in Canada (en-CA, fr-CA), provide three alphanumeric characters followed by a space and three more uppercase alphanumeric characters, all in the range of A0A 1A0 to Y1A 7A3.
  • Any value specified for CountryCode is ignored for these locales.
For locales outside of North America, specify the country code in CountryCode. This determines which television services are returned for these locales. Do not specify a postal code for those countries.
For any request, you can limit the results to just the services offered by a single cable or satellite operator. To do that, provide the MSO ID for that operator as a value for the MSOid parameter. Don't know what that ID is? First request the list of services in an area and look through the response for that operator. Then you can use it for any subsequest request.
NameRequiredTypeDescription
CountryCode Conditional String Two-character, upper-case country code. Valid countries include:
  • AR
Argentina
  • SV
El Salvador
  • NI
Nicaragua
  • AT
Austria
  • FI
Finland
  • NO
Norway
  • BE
Belgium
  • FR
France
  • PA
Panama
  • BM
Bermuda
  • DE
Germany
  • PE
Peru
  • BO
Bolivia
  • GT
Guatemala
  • PL
Poland
  • BR
Brazil
  • HN
Honduras
  • PT
Portugal
  • CA
Canada
  • IE
Ireland
  • ES
Spain
  • CL
Chile
  • IT
Italy
  • SE
Sweden
  • CO
Colombia
  • JM
Jamaica
  • CH
Switzerland
  • CR
Costa Rica
  • LU
Luxembourg 
  • GB
United Kingdom*
  • DK
Denmark
  • MX
Mexico
  • US
United States
  • DO
Dominican Republic 
  • NL
Netherlands
  • VE
Venezuela
  • EC
Ecuador

* Includes Wales, Scotland, and Northern Ireland.

Condition: Required for countries outside of North America.

MSOId No String Database ID of a specific cable or satellite operator (multi-system operator or MSO). Include this optional parameter if you want to return just the services offered by that operator.

To get the MSO ID for an operator, first request the list of services in an area and then look through the response for that operator.

PostalCode Conditional String Postal code in the coverage area in Canada or the United States.
  • For locales in the United States (en-US, es-US), provide five digits in the range of 00501 to 99950.
  • For locales in Canada (en-CA, fr-CA), provide three alphanumeric characters followed by a space and three more uppercase alphanumeric characters, all in the range of A0A 1A0 to Y1A 7A3.

Condition: Required for locales in Canada or the United States.

Do not specify a postal code for other countries. Results may be unpredictable.

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