Difference between revisions of "UNIAPI Specification"
(127 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
− | + | {{:UNI API Introduction}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Enumerations == | == Enumerations == | ||
Line 201: | Line 9: | ||
==== [[BundleStatus]] ==== | ==== [[BundleStatus]] ==== | ||
==== [[CatalogItemType]] ==== | ==== [[CatalogItemType]] ==== | ||
− | ==== [[ | + | ==== [[CatalogType]] (openGvp) ==== |
+ | ==== [[ChannelContentType]] ==== | ||
+ | ==== [[CommercializationType]] ==== | ||
==== [[ContentCriteriaField]] ==== | ==== [[ContentCriteriaField]] ==== | ||
==== [[ContentCriteriaObject]] ==== | ==== [[ContentCriteriaObject]] ==== | ||
+ | ==== [[ContentType]] (openGvp) ==== | ||
==== [[DeviceType]] ==== | ==== [[DeviceType]] ==== | ||
==== [[DRMType]] ==== | ==== [[DRMType]] ==== | ||
+ | ==== [[ExtraMetadataType]] ==== | ||
==== [[Gender]] ==== | ==== [[Gender]] ==== | ||
==== [[GenreSearchType]] ==== | ==== [[GenreSearchType]] ==== | ||
==== [[HighlightType]] ==== | ==== [[HighlightType]] ==== | ||
− | ==== [[ | + | ==== [[HtmlType]] ==== |
==== [[ImageType]] ==== | ==== [[ImageType]] ==== | ||
==== [[LinkType]] ==== | ==== [[LinkType]] ==== | ||
Line 217: | Line 29: | ||
==== [[MovieSortType]] ==== | ==== [[MovieSortType]] ==== | ||
==== [[MovieType]] ==== | ==== [[MovieType]] ==== | ||
− | ==== [[ | + | ==== [[PaymentType]] ==== |
==== [[PersonSearchType]] ==== | ==== [[PersonSearchType]] ==== | ||
+ | ==== [[PlaybackRight]] ==== | ||
==== [[PlaybackType]] ==== | ==== [[PlaybackType]] ==== | ||
==== [[PlaylistStatus]] ==== | ==== [[PlaylistStatus]] ==== | ||
+ | ==== [[PlayType]] ==== | ||
==== [[PriceType]] ==== | ==== [[PriceType]] ==== | ||
==== [[ProductType]] ==== | ==== [[ProductType]] ==== | ||
+ | ==== [[ProgramType]] ==== | ||
==== [[PurchaseStatus]] ==== | ==== [[PurchaseStatus]] ==== | ||
==== [[Quality]] ==== | ==== [[Quality]] ==== | ||
Line 233: | Line 48: | ||
==== [[ReminderType]] ==== | ==== [[ReminderType]] ==== | ||
==== [[Role]] ==== | ==== [[Role]] ==== | ||
+ | ==== [[ServiceIdType]] ==== | ||
+ | ==== [[SlotType]] ==== | ||
+ | ==== [[SocialNetworkType]] ==== | ||
+ | ==== [[SortType]] ==== | ||
+ | ==== [[SortOrder]] ==== | ||
==== [[StatusCode]] ==== | ==== [[StatusCode]] ==== | ||
==== [[StreamingType]] ==== | ==== [[StreamingType]] ==== | ||
Line 239: | Line 59: | ||
==== [[SubscriptionType]] ==== | ==== [[SubscriptionType]] ==== | ||
==== [[TagType]] ==== | ==== [[TagType]] ==== | ||
+ | ==== [[TimeShiftStatus]] ==== | ||
==== [[TVTransport]] ==== | ==== [[TVTransport]] ==== | ||
− | ==== [[ | + | ==== [[UrlType]] ==== |
+ | ==== [[UserPinType]] ==== | ||
==== [[UserRecommendationsType]] ==== | ==== [[UserRecommendationsType]] ==== | ||
==== [[UserStatus]] ==== | ==== [[UserStatus]] ==== | ||
Line 246: | Line 68: | ||
==== [[UserStorageUnit]] ==== | ==== [[UserStorageUnit]] ==== | ||
==== [[UserType]] ==== | ==== [[UserType]] ==== | ||
+ | ==== [[SimpleItem]] ==== | ||
+ | |||
+ | |||
+ | |||
Line 257: | Line 83: | ||
== Data Types == | == Data Types == | ||
==== [[AccessReason]] ==== | ==== [[AccessReason]] ==== | ||
− | ==== [[ | + | ==== [[Instance]] ==== |
+ | ==== [[InstanceAgeRating]] ==== | ||
==== [[CatalogItem]] ==== | ==== [[CatalogItem]] ==== | ||
==== [[Channel]] ==== | ==== [[Channel]] ==== | ||
+ | ==== [[ChannelCount]] ==== | ||
==== [[ChannelMap]] ==== | ==== [[ChannelMap]] ==== | ||
==== [[ChannelMapLiveChannel]] ==== | ==== [[ChannelMapLiveChannel]] ==== | ||
+ | ==== [[Distributor]] ==== | ||
+ | ==== [[EditorialContent]] ==== | ||
==== [[EpgLiveSchedule]] ==== | ==== [[EpgLiveSchedule]] ==== | ||
==== [[EpgLiveChannel]] ==== | ==== [[EpgLiveChannel]] ==== | ||
==== [[EpgLiveProgram]] ==== | ==== [[EpgLiveProgram]] ==== | ||
==== [[EpgLiveProgramDetails]] ==== | ==== [[EpgLiveProgramDetails]] ==== | ||
− | ==== [[ | + | ==== [[ExtraMetaData]] ==== |
+ | ==== [[Genre]] ==== | ||
==== [[Image]] ==== | ==== [[Image]] ==== | ||
+ | ==== [[InstanceAgeRating]] ==== | ||
==== [[InstanceSettings]] ==== | ==== [[InstanceSettings]] ==== | ||
− | ==== [[ | + | ==== [[Language]] ==== |
+ | ==== [[LicenseInfo]] ==== | ||
==== [[LiveChannel]] ==== | ==== [[LiveChannel]] ==== | ||
==== [[LiveChannelsPlayback]] ==== | ==== [[LiveChannelsPlayback]] ==== | ||
Line 277: | Line 110: | ||
==== [[LiveStream]] ==== | ==== [[LiveStream]] ==== | ||
==== [[Login]] ==== | ==== [[Login]] ==== | ||
+ | ==== [[Media]] ==== | ||
+ | ==== [[MediaUrlResult]] ==== | ||
+ | ==== [[MiniAccessReason]] ==== | ||
+ | ==== [[MiniUserProduct]] ==== | ||
+ | ==== [[Movie]] ==== | ||
==== [[MovieStaff]] ==== | ==== [[MovieStaff]] ==== | ||
+ | ==== [[OBPinDefault]] ==== | ||
==== [[Person]] ==== | ==== [[Person]] ==== | ||
==== [[PersonalLiveChannel]] ==== | ==== [[PersonalLiveChannel]] ==== | ||
==== [[PricingModel]] ==== | ==== [[PricingModel]] ==== | ||
+ | ==== [[Producer]] ==== | ||
+ | ==== [[Product]] ==== | ||
+ | ==== [[ProductTag]] ==== | ||
+ | ==== [[PurchaseResponse]] ==== | ||
+ | ==== [[QueueItem]] ==== | ||
==== [[RecordingSchedule]] ==== | ==== [[RecordingSchedule]] ==== | ||
==== [[ReducedLiveSchedule]] ==== | ==== [[ReducedLiveSchedule]] ==== | ||
==== [[Region]] ==== | ==== [[Region]] ==== | ||
==== [[RegistrationField]] ==== | ==== [[RegistrationField]] ==== | ||
+ | ==== [[Result]] ==== | ||
==== [[Service]] ==== | ==== [[Service]] ==== | ||
+ | ==== [[SimpleMovie]] ==== | ||
==== [[Subscription]] ==== | ==== [[Subscription]] ==== | ||
+ | ==== [[SubtitleJSON]] ==== | ||
+ | ==== [[SubtitlesJSON]] ==== | ||
+ | ==== [[Tag]] ==== | ||
+ | ==== [[TransparentProvider]] ==== | ||
+ | ==== [[TrustedDevice]] ==== | ||
+ | ==== [[TrustedDeviceChallenge]] ==== | ||
+ | ==== [[TrustedDeviceList]] ==== | ||
==== [[TVTechnology]] ==== | ==== [[TVTechnology]] ==== | ||
+ | ==== [[User]] ==== | ||
+ | ==== [[UserCustomField]] ==== | ||
+ | ==== [[UserPinStatus]] ==== | ||
+ | ==== [[UserProduct]] ==== | ||
+ | ==== [[UserQueue]] ==== | ||
+ | ==== [[UserSocialNetworkStatus]] ==== | ||
==== [[UserStorageInfo]] ==== | ==== [[UserStorageInfo]] ==== | ||
+ | ==== [[UserTags]] ==== | ||
+ | ==== [[UserVideoServiceInfo]] ==== | ||
Line 296: | Line 157: | ||
<br> | <br> | ||
=== Authentication Service === | === Authentication Service === | ||
− | ==== | + | ==== [[BuildOIDCAuthRequest]] ==== |
− | ==== | + | ==== [[BuildOIDCLogoutRequest]] ==== |
− | ==== | + | ==== [[GetToolboxToken]] ==== |
− | ==== | + | ==== [[LoginAnonymous]] ==== |
− | ==== | + | ==== [[LoginApplicationToken]] ==== |
− | ==== | + | ==== [[LoginRememberUser]] ==== |
− | ==== | + | ==== [[LoginTrustedDevice]] ==== |
− | ==== | + | ==== [[LoginUserCode]] ==== |
− | ==== | + | ==== [[LoginUserHashCode]] ==== |
− | ==== | + | ==== [[LoginUserPassword]] ==== |
− | ==== | + | ==== [[LoginUserPasswordTEF]] ==== |
− | ==== | + | ==== [[RecoverPassword]] ==== |
− | ==== | + | ==== [[RecoverPasswordHash]] ==== |
+ | ==== [[RecoverPasswordLink]] ==== | ||
+ | ==== [[RememberUser]] ==== | ||
+ | ==== [[Renew]] ==== | ||
<br> | <br> | ||
+ | |||
=== AutoComplete Service === | === AutoComplete Service === | ||
− | ==== - [[SearchAutoComplete]] ==== | + | ==== <span style="text-decoration:line-through">[[SearchAutoComplete]]</span><span style="color:red"> DEPRECATED</span> ==== |
<br> | <br> | ||
+ | |||
=== Bundle Service === | === Bundle Service === | ||
− | ==== - [[GetAllBundles]] ==== | + | ==== <span style="text-decoration:line-through">[[GetAllBundles]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetBundle]] ==== | + | ==== <span style="text-decoration:line-through">[[GetBundle]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetBundleCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetBundleMovies]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetBundles]] ==== | + | ==== <span style="text-decoration:line-through">[[GetBundles]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetMovieBundles]] ==== | + | ==== <span style="text-decoration:line-through">[[GetMovieBundles]]</span><span style="color:red"> DEPRECATED</span> ==== |
<br> | <br> | ||
+ | |||
=== Channel Service === | === Channel Service === | ||
− | ==== - [[GetAllChannels]] ==== | + | ==== <span style="text-decoration:line-through">[[GetAllChannels]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetChannel]] ==== | + | ==== <span style="text-decoration:line-through">[[GetCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetChannelCatalogItems]] ==== | + | ==== <span style="text-decoration:line-through">[[GetChannel]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannelCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannelChildren]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannelEditorialContents]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannels]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetChannelSimpleProductsCount]] ==== | + | ==== <span style="text-decoration:line-through">[[GetChannelSimpleMoviesCount]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannelSimpleProductsCount]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetLiveChannelCommercialOffers]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetChannelSimpleProductsStb]] ==== | + | |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetChannelHighlights]]</span><span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetTopRecommendedContents]] ==== | + | ==== <span style="text-decoration:line-through">[[GetChannelSimpleMovies]]</span><span style="color:red"> DEPRECATED</span> ==== |
+ | ==== <span style="text-decoration:line-through">[[GetChannelSimpleProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetChannelSimpleProductsStb]] </span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetChannelTopHighlights]] </span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedChannelProductsTree]] </span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedChannelTree]] </span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetTopRecommendedContents]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
<br> | <br> | ||
+ | |||
=== Configuration Service === | === Configuration Service === | ||
− | ==== | + | ==== [[GetInstance]]==== |
− | ==== | + | ==== [[GetInstanceID]]==== |
− | ==== | + | ==== [[GetInstances]]==== |
− | ==== | + | ==== [[GetInstanceSettings]]==== |
− | ==== | + | ==== [[GetLanguages]]==== |
− | ==== | + | ==== [[GetVersion]]==== |
<br> | <br> | ||
=== Content Criteria Service === | === Content Criteria Service === | ||
− | ==== - [[GetContentSelection]]==== | + | ==== <span style="text-decoration:line-through">[[GetContentSelection]]</span> <span style="color:red"> DEPRECATED</span> ==== |
+ | |||
+ | <br> | ||
+ | === Dictionary Service === | ||
+ | ==== [[GetDictionary]] ==== | ||
<br> | <br> | ||
=== Epg Service === | === Epg Service === | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | ==== <span style="text-decoration:line-through">[[GetActiveLiveChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetAESKey]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetAllLiveChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetChannelAvailableStreams]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetChannelMap]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetChannelMapLiveChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedLiveChannelsSchedule]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedLiveChannelsSchedules]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedLiveProgram]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetEpgVersion]]==== | ||
+ | ==== [[GetLastViewedLiveChannelId]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannel]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelByCallLetter]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelCommercialOffers]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsPlayback]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsReducedLiveSchedules]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsReducedLiveSchedulesByGenre]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsReducedLiveSchedulesSortedByRating]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsSchedules]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveProgramSchedules]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveProgramSchedulesWithDate]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveSchedulesById]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | ==== <span style="text-decoration:line-through">[[GetPersonalLiveChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetRegions]]==== | ||
+ | ==== [[GetSeriesSchedules]]==== | ||
+ | ==== [[GetTVTechnologiesByRegion]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserAvailableStreams]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserChannelMap]]==== | ||
+ | ==== [[GetUserFavoriteLiveChannels]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserLiveChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | ==== <span style="text-decoration:line-through">[[GetUserLiveChannelsPlayback]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[SetLastViewedLiveChannel]]==== | ||
+ | ==== [[SetUserLiveChannelTag]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveProgramsScheduleBlock]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsSchedule]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelsScheduleBlock]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelPrograms]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserLiveChannelTag]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserLockedChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveSchedule]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveSchedules]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetDetailedLivePrograms]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelDetailedPrograms]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelUrl]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetLiveChannelUrlList]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
<br> | <br> | ||
+ | |||
=== Event Service === | === Event Service === | ||
− | ==== - [[AddEvent]]==== | + | |
− | ==== | + | ==== <span style="text-decoration:line-through">[[AddEvent]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[AddEventPerformsAction]]==== | + | ==== [[AddEventBatch]]==== |
− | ==== - [[AddEventPlayback]]==== | + | ==== <span style="text-decoration:line-through">[[AddEventPerformsAction]]</span> <span style="color:red"> DEPRECATED</span> ==== |
+ | |||
+ | ==== <span style="text-decoration:line-through">[[AddEventPlayback]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | <br> | ||
+ | === Interest Service === | ||
+ | ==== [[GetInstanceInterests]]==== | ||
+ | ==== [[GetUserInterests]]==== | ||
+ | ==== [[ManageUserInterests]]==== | ||
<br> | <br> | ||
=== Genre Service === | === Genre Service === | ||
− | ==== - [[GetAllGenres]]==== | + | ==== <span style="text-decoration:line-through">[[GetAllGenres]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetGenre]]==== | + | ==== <span style="text-decoration:line-through">[[GetGenre]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetGenres]]==== | + | ==== <span style="text-decoration:line-through">[[GetGenres]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetGenreSimpleMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetGenreSimpleMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[SearchGenres]]==== | + | ==== <span style="text-decoration:line-through">[[SearchGenres]]</span> <span style="color:red"> DEPRECATED</span> ==== |
<br> | <br> | ||
=== Movie Service === | === Movie Service === | ||
− | ==== - [[GetAllSimpleMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetAllMoviesCatalogItems]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetAllSimpleMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetMovie]]==== | + | ==== <span style="text-decoration:line-through">[[GetExtCatchUpURL]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetMovieCommercialOffers]]==== | + | |
− | ==== - [[GetMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetMovie]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetSeasonEpisodeSimpleMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetMovieCommercialOffers]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetSeriesSeasonSimpleMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== | + | ==== <span style="text-decoration:line-through">[[GetSeasonEpisodeSimpleMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[SearchProducts]]==== | + | |
− | ==== - [[SearchSimpleMovies]]==== | + | ==== <span style="text-decoration:line-through">[[GetSeriesSeasonSimpleMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== |
+ | |||
+ | ==== [[GetSubtitle]]==== | ||
+ | ==== <span style="text-decoration:line-through">[[SearchProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[SearchSimpleMovies]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
<br> | <br> | ||
+ | === Network Pvr Service === | ||
+ | ==== [[AddRecordingSchedule]]==== | ||
+ | ==== [[CancelRecordingSchedule]]==== | ||
+ | ==== [[DeleteRecordingSchedule]]==== | ||
+ | ==== [[GetAllRecordingSchedules]]==== | ||
+ | ==== [[GetRecordingSchedule]]==== | ||
+ | ==== [[GetUserStorageInfo]]==== | ||
+ | ==== [[SetUserRecordingPin]]==== | ||
+ | ==== [[GetRecordingUrl]]==== | ||
+ | ==== [[ProtectRecording]]==== | ||
+ | |||
+ | |||
+ | <br> | ||
+ | |||
=== Payment Service === | === Payment Service === | ||
− | ==== | + | ==== [[GetInstanceCredits]]==== |
− | ==== | + | ==== [[GetPaymentSettings]]==== |
<br> | <br> | ||
+ | |||
+ | === InstanceParameter Service === | ||
+ | === [[GetKeyValues]] === | ||
+ | |||
+ | <br> | ||
+ | |||
+ | === Parameter Service === | ||
+ | ==== <span style="text-decoration:line-through">[[GetKeyValues]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | <br> | ||
+ | |||
=== Person Service === | === Person Service === | ||
+ | ==== <span style="text-decoration:line-through">[[GetAllPersons]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPerson]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPersonProducts]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPersons]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[SearchPersons]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPersonSimpleMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | |||
<br> | <br> | ||
=== Playback Service === | === Playback Service === | ||
+ | ==== [[CanWatchMedia]]==== | ||
+ | ==== [[GetMediaUrl]]==== | ||
+ | ==== [[GetMediaUrlsStb]]==== | ||
+ | ==== [[GetMediaUrlStb]]==== | ||
+ | ==== [[GetMovieResumeData]]==== | ||
+ | ==== [[GetMovieResumesData]]==== | ||
+ | ==== [[GetPlayReadyLicenseInfo]]==== | ||
+ | ==== [[GetUserResumeData]]==== | ||
+ | ==== [[GetUserItemsResumeData]]==== | ||
+ | ==== [[PlaybackHeartBeatLive]]==== | ||
+ | ==== [[PlaybackHeartBeatVod]]==== | ||
+ | ==== [[PlaybackHeartBeatRecording]]==== | ||
+ | ==== [[SetMovieResumeData]]==== | ||
+ | ==== [[SetItemResumeData]] ==== | ||
+ | |||
<br> | <br> | ||
=== Playlist Service === | === Playlist Service === | ||
+ | ==== <span style="text-decoration:line-through">[[GetAllPlaylists]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetAllPlaylistsTimeStamp]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetMoviePlaylists]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPlaylist]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPlaylistMovies]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPlaylists]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | |||
<br> | <br> | ||
+ | |||
=== Purchase Service === | === Purchase Service === | ||
− | ==== | + | ==== [[CancelProduct]] ==== |
− | ==== - [[GetAvailablePricingModels]] ==== | + | ==== [[CancelPurchase]] ==== |
+ | ==== [[ConfirmPurchase]] ==== | ||
+ | ==== [[CreatePurchase]] ==== | ||
+ | ==== [[CreatePurchaseStb]] ==== | ||
+ | ==== [[GetActiveProductEndDate]] ==== | ||
+ | ==== [[GetActiveProductPurchaseStatus]] ==== | ||
+ | ==== [[GetAvailablePaymentMethods]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetAvailablePricingModels]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetCreditCard]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetPricingModel]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetProductName]] ==== | ||
+ | ==== [[GetWebpayPurchaseHtmlPage]] ==== | ||
+ | ==== [[ManageCreditCard]] ==== | ||
+ | ==== [[SetInstanceDeviceDefaultPayment]] ==== | ||
+ | ==== [[SetUserDefaultPayment]] ==== | ||
+ | |||
<br> | <br> | ||
+ | |||
=== Registration Service === | === Registration Service === | ||
+ | ==== [[ChangePassword]] ==== | ||
+ | ==== [[DisableUser]] ==== | ||
+ | ==== [[EnableUser]] ==== | ||
+ | ==== [[GetAllTrustedDevices]] ==== | ||
+ | ==== [[GetApplicationToken]] ==== | ||
+ | ==== [[GetPairedApplications]] ==== | ||
+ | ==== [[GetRegistrationFields]] ==== | ||
+ | ==== [[GetTrustedDeviceChallengeCode]] ==== | ||
+ | ==== [[GetTrustedDevices]] ==== | ||
+ | ==== [[ModifyTrustedDevice]] ==== | ||
+ | ==== [[ModifyUser]] ==== | ||
+ | ==== [[RegisterTrustedDevice]] ==== | ||
+ | ==== [[RegisterTrustedDeviceChallenge]] ==== | ||
+ | ==== [[RegisterUser]] ==== | ||
+ | ==== [[RemoveApplicationToken]] ==== | ||
+ | ==== [[RemoveTrustedDevice]] ==== | ||
+ | ==== [[RemoveUser]] ==== | ||
+ | ==== [[SendConfirmationEmail]] ==== | ||
+ | ==== [[SetMinimumAgeRating]] ==== | ||
+ | |||
<br> | <br> | ||
=== Remote Pvr Service === | === Remote Pvr Service === | ||
− | < | + | ==== <span style="text-decoration:line-through">[[AddRecordingDefinition]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | === | + | ==== <span style="text-decoration:line-through">[[GetProgramInfos]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetRecordings]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[GetStorageInfos]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[RemoveCompletedRecordings]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[RemoveRecordingDefinition]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[RemoveUpcomingRecordings]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[ | + | ==== <span style="text-decoration:line-through">[[UpdateCompletedRecording]]</span> <span style="color:red"> DEPRECATED</span> ==== |
+ | ==== <span style="text-decoration:line-through">[[UpdateOneTimeToSeries]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[UpdateRecordingDefinition]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[UpdateRecordingDefinitionPriorities]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[UpdateUpcomingRecording]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
<br> | <br> | ||
=== Search Service === | === Search Service === | ||
+ | ==== <span style="text-decoration:line-through">[[SearchContent]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
<br> | <br> | ||
=== Subscription Service === | === Subscription Service === | ||
− | ==== - [[GetAllSubscriptions]] ==== | + | ==== <span style="text-decoration:line-through">[[GetAllInstanceServices]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetSubscription]] ==== | + | ==== <span style="text-decoration:line-through">[[GetAllSubscriptions]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetSubscriptionLiveChannels]] ==== | + | ==== <span style="text-decoration:line-through">[[GetAllSubscriptionsCatalogItems]]</span> <span style="color:red"> DEPRECATED</span> ==== |
− | ==== - [[GetSubscriptionServices]] ==== | + | ==== <span style="text-decoration:line-through">[[GetMovieSubscriptions]]</span> <span style="color:red"> DEPRECATED</span> ==== |
+ | ==== <span style="text-decoration:line-through">[[GetSubscription]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptionLiveChannels]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptionMovies]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptions]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptionServices]]</span> <span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | ==== <span style="text-decoration:line-through">[[GetStbSubscriptions]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptionChannels]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetSubscriptionPlaylists]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | |||
<br> | <br> | ||
=== Time Service === | === Time Service === | ||
+ | ==== [[GetTime]] ==== | ||
+ | |||
+ | <br> | ||
+ | === Timeshift Service === | ||
+ | ==== [[GetCurrentInstanceChannelSet]] ==== | ||
+ | ==== [[GetCurrentUserChannelSet]] ==== | ||
+ | ==== [[GetInstanceChannelSet]] ==== | ||
+ | ==== [[GetInstanceData]] ==== | ||
+ | ==== [[GetUserChannelSet]] ==== | ||
+ | ==== [[GetUserData]] ==== | ||
+ | ==== [[GetUserStatus]] ==== | ||
+ | ==== [[NewTermsAccepted]] ==== | ||
+ | ==== [[UserActivation]] ==== | ||
+ | ==== [[UserDeactivation]] ==== | ||
+ | ==== [[UserMaxCapacityReached]] ==== | ||
+ | |||
<br> | <br> | ||
=== User Service === | === User Service === | ||
− | ==== - [[GetUserSubscriptions]] ==== | + | ==== [[ChangePin]] ==== |
− | < | + | ==== [[ChangePinFirstUse]] ==== |
− | === | + | ==== [[CheckPin]] ==== |
− | < | + | ==== [[DisablePin]] ==== |
− | === | + | ==== [[EnablePin]] ==== |
+ | ==== [[GetDefaultOBPinNumber]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetFullView]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetNextSerieEpisodeForUser]] ==== | ||
+ | ==== [[GetNodeRecommendations]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetNodeRecommendations]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetMiniUserProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetRecoms]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetRootRecommendationsByView]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | |||
+ | ==== <span style="text-decoration:line-through">[[GetRootRecommendationsCombined]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUser]] ==== | ||
+ | ==== [[GetUserAudioDefault]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserBundles]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserBundlesCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserChallengeCode]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserPlaylists]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserPreference]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserQueue]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserRecommendations]]</span> <span style="color:red">DEPRECATED GVP 3.0</span>==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserRentedProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserRentedSimpleMovies]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserRights]] ==== | ||
+ | ==== [[GetUserServices]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserSeasons]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserSubscriptions]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserSubscriptionsCatalogItems]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserSubtitleDefault]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserTaggedProducts]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserTaggedSimpleMovies]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserTags]] ==== | ||
+ | ==== [[GetUserTimestamp]] ==== | ||
+ | ==== [[GetUserTimestamps]] ==== | ||
+ | ==== [[GetAuraId]] ==== | ||
+ | ==== [[GetAuraToken]] ==== | ||
+ | ==== <span style="text-decoration:line-through">[[GetUserWatchHistory]]</span><span style="color:red"> DEPRECATED</span> ==== | ||
+ | ==== [[GetUserWithEmail]] ==== | ||
+ | ==== [[LockedByMandatorySubscription]] ==== | ||
+ | ==== [[RemoveWatchHistory]] ==== | ||
+ | ==== [[SetUserAudioDefault]] ==== | ||
+ | ==== [[SetUserPreference]] ==== | ||
+ | ==== [[SetUserSubtitleDefault]] ==== | ||
+ | ==== [[TagProduct]] ==== | ||
+ | ==== [[TagItem]] ==== | ||
+ | ==== [[UntagProduct]] ==== | ||
+ | ==== [[UntagItem]] ==== | ||
+ | ==== [[GetItemsTags]] ==== | ||
+ | ==== [[UpdateUserFirstAccess]] ==== | ||
+ | ==== [[AcceptServicesAgreement]] ==== | ||
+ | ==== [[RemoveServicesAgreement]] ==== | ||
+ | |||
<br> | <br> | ||
+ | |||
=== WebOnlyRegistration Service === | === WebOnlyRegistration Service === | ||
+ | ==== [[ConfirmRegisterTrustedDeviceChallenge]] ==== | ||
+ | ==== [[ConfirmRegistrationEmail]] ==== | ||
+ | ==== [[GetUserPrePaidHistory]] ==== | ||
+ | ==== [[RegisterPrePaidCode]] ==== | ||
+ | ==== [[UserRegistrationStatus]] ==== |
Latest revision as of 21:34, 15 November 2020
Contents
- 1 Introduction
- 1.1 Overview
- 1.2 URL Structure
- 1.3 OAuth Signature
- 1.4 GET and POST Support
- 1.5 Authentication
- 1.6 Multi-Instance Support
- 1.7 Multi-Platform Support
- 1.8 Multi-Language Support
- 1.9 Registration
- 1.10 TV Series Handling
- 1.11 Purchase
- 1.12 Analytics
- 1.13 Globalization and Culture Info
- 1.14 Session Cookie generation
- 2 Enumerations
- 2.1 AdultFilterType
- 2.2 AutoCompleteResultType
- 2.3 BundleStatus
- 2.4 CatalogItemType
- 2.5 CatalogType (openGvp)
- 2.6 ChannelContentType
- 2.7 CommercializationType
- 2.8 ContentCriteriaField
- 2.9 ContentCriteriaObject
- 2.10 ContentType (openGvp)
- 2.11 DeviceType
- 2.12 DRMType
- 2.13 ExtraMetadataType
- 2.14 Gender
- 2.15 GenreSearchType
- 2.16 HighlightType
- 2.17 HtmlType
- 2.18 ImageType
- 2.19 LinkType
- 2.20 MediaType
- 2.21 MovieAccessReason
- 2.22 MovieSearchType
- 2.23 MovieSortType
- 2.24 MovieType
- 2.25 PaymentType
- 2.26 PersonSearchType
- 2.27 PlaybackRight
- 2.28 PlaybackType
- 2.29 PlaylistStatus
- 2.30 PlayType
- 2.31 PriceType
- 2.32 ProductType
- 2.33 ProgramType
- 2.34 PurchaseStatus
- 2.35 Quality
- 2.36 QueueType
- 2.37 RecommendationType
- 2.38 RecordingScheduleState
- 2.39 RecurrenceType
- 2.40 RegistrationFieldType
- 2.41 RegistrationRequiredFieldType
- 2.42 ReminderType
- 2.43 Role
- 2.44 ServiceIdType
- 2.45 SlotType
- 2.46 SocialNetworkType
- 2.47 SortType
- 2.48 SortOrder
- 2.49 StatusCode
- 2.50 StreamingType
- 2.51 SubscriptionPurchaseType
- 2.52 SubscriptionStatus
- 2.53 SubscriptionType
- 2.54 TagType
- 2.55 TimeShiftStatus
- 2.56 TVTransport
- 2.57 UrlType
- 2.58 UserPinType
- 2.59 UserRecommendationsType
- 2.60 UserStatus
- 2.61 UserStorageType
- 2.62 UserStorageUnit
- 2.63 UserType
- 2.64 SimpleItem
- 3 Data Types
- 3.1 AccessReason
- 3.2 Instance
- 3.3 InstanceAgeRating
- 3.4 CatalogItem
- 3.5 Channel
- 3.6 ChannelCount
- 3.7 ChannelMap
- 3.8 ChannelMapLiveChannel
- 3.9 Distributor
- 3.10 EditorialContent
- 3.11 EpgLiveSchedule
- 3.12 EpgLiveChannel
- 3.13 EpgLiveProgram
- 3.14 EpgLiveProgramDetails
- 3.15 ExtraMetaData
- 3.16 Genre
- 3.17 Image
- 3.18 InstanceAgeRating
- 3.19 InstanceSettings
- 3.20 Language
- 3.21 LicenseInfo
- 3.22 LiveChannel
- 3.23 LiveChannelsPlayback
- 3.24 LiveChannelStreams
- 3.25 LiveProgram
- 3.26 LiveSchedule
- 3.27 LiveStream
- 3.28 Login
- 3.29 Media
- 3.30 MediaUrlResult
- 3.31 MiniAccessReason
- 3.32 MiniUserProduct
- 3.33 Movie
- 3.34 MovieStaff
- 3.35 OBPinDefault
- 3.36 Person
- 3.37 PersonalLiveChannel
- 3.38 PricingModel
- 3.39 Producer
- 3.40 Product
- 3.41 ProductTag
- 3.42 PurchaseResponse
- 3.43 QueueItem
- 3.44 RecordingSchedule
- 3.45 ReducedLiveSchedule
- 3.46 Region
- 3.47 RegistrationField
- 3.48 Result
- 3.49 Service
- 3.50 SimpleMovie
- 3.51 Subscription
- 3.52 SubtitleJSON
- 3.53 SubtitlesJSON
- 3.54 Tag
- 3.55 TransparentProvider
- 3.56 TrustedDevice
- 3.57 TrustedDeviceChallenge
- 3.58 TrustedDeviceList
- 3.59 TVTechnology
- 3.60 User
- 3.61 UserCustomField
- 3.62 UserPinStatus
- 3.63 UserProduct
- 3.64 UserQueue
- 3.65 UserSocialNetworkStatus
- 3.66 UserStorageInfo
- 3.67 UserTags
- 3.68 UserVideoServiceInfo
- 4 Services and methods
- 4.1 Authentication Service
- 4.1.1 BuildOIDCAuthRequest
- 4.1.2 BuildOIDCLogoutRequest
- 4.1.3 GetToolboxToken
- 4.1.4 LoginAnonymous
- 4.1.5 LoginApplicationToken
- 4.1.6 LoginRememberUser
- 4.1.7 LoginTrustedDevice
- 4.1.8 LoginUserCode
- 4.1.9 LoginUserHashCode
- 4.1.10 LoginUserPassword
- 4.1.11 LoginUserPasswordTEF
- 4.1.12 RecoverPassword
- 4.1.13 RecoverPasswordHash
- 4.1.14 RecoverPasswordLink
- 4.1.15 RememberUser
- 4.1.16 Renew
- 4.2 AutoComplete Service
- 4.3 Bundle Service
- 4.4 Channel Service
- 4.4.1 GetAllChannels DEPRECATED
- 4.4.2 GetCatalogItems DEPRECATED
- 4.4.3 GetChannel DEPRECATED
- 4.4.4 GetChannelCatalogItems DEPRECATED
- 4.4.5 GetChannelChildren DEPRECATED
- 4.4.6 GetChannelEditorialContents DEPRECATED
- 4.4.7 GetChannels DEPRECATED
- 4.4.8 GetChannelSimpleMoviesCount DEPRECATED
- 4.4.9 GetChannelSimpleProductsCount DEPRECATED
- 4.4.10 GetLiveChannelCommercialOffers DEPRECATED
- 4.4.11 GetChannelHighlights DEPRECATED
- 4.4.12 GetChannelSimpleMovies DEPRECATED
- 4.4.13 GetChannelSimpleProducts DEPRECATED
- 4.4.14 GetChannelSimpleProductsStb DEPRECATED
- 4.4.15 GetChannelTopHighlights DEPRECATED
- 4.4.16 GetDetailedChannelProductsTree DEPRECATED
- 4.4.17 GetDetailedChannelTree DEPRECATED
- 4.4.18 GetTopRecommendedContents DEPRECATED
- 4.5 Configuration Service
- 4.6 Content Criteria Service
- 4.7 Dictionary Service
- 4.8 Epg Service
- 4.8.1 GetActiveLiveChannels DEPRECATED
- 4.8.2 GetAESKey
- 4.8.3 GetAllLiveChannels DEPRECATED
- 4.8.4 GetChannelAvailableStreams DEPRECATED
- 4.8.5 GetChannelMap
- 4.8.6 GetChannelMapLiveChannels DEPRECATED
- 4.8.7 GetDetailedLiveChannelsSchedule DEPRECATED
- 4.8.8 GetDetailedLiveChannelsSchedules DEPRECATED
- 4.8.9 GetDetailedLiveProgram DEPRECATED
- 4.8.10 GetEpgVersion
- 4.8.11 GetLastViewedLiveChannelId
- 4.8.12 GetLiveChannel DEPRECATED
- 4.8.13 GetLiveChannelByCallLetter DEPRECATED
- 4.8.14 GetLiveChannelCommercialOffers DEPRECATED
- 4.8.15 GetLiveChannelsCatalogItems DEPRECATED
- 4.8.16 GetLiveChannelsPlayback DEPRECATED
- 4.8.17 GetLiveChannelsReducedLiveSchedules DEPRECATED
- 4.8.18 GetLiveChannelsReducedLiveSchedulesByGenre DEPRECATED
- 4.8.19 GetLiveChannelsReducedLiveSchedulesSortedByRating DEPRECATED
- 4.8.20 GetLiveChannelsSchedules DEPRECATED
- 4.8.21 GetLiveProgramSchedules DEPRECATED
- 4.8.22 GetLiveProgramSchedulesWithDate DEPRECATED
- 4.8.23 GetLiveSchedulesById DEPRECATED
- 4.8.24 GetPersonalLiveChannels DEPRECATED
- 4.8.25 GetRegions
- 4.8.26 GetSeriesSchedules
- 4.8.27 GetTVTechnologiesByRegion
- 4.8.28 GetUserAvailableStreams DEPRECATED
- 4.8.29 GetUserChannelMap
- 4.8.30 GetUserFavoriteLiveChannels
- 4.8.31 GetUserLiveChannels DEPRECATED
- 4.8.32 GetUserLiveChannelsPlayback DEPRECATED
- 4.8.33 SetLastViewedLiveChannel
- 4.8.34 SetUserLiveChannelTag
- 4.8.35 GetLiveProgramsScheduleBlock DEPRECATED
- 4.8.36 GetLiveChannelsSchedule DEPRECATED
- 4.8.37 GetLiveChannelsScheduleBlock DEPRECATED
- 4.8.38 GetLiveChannelPrograms DEPRECATED
- 4.8.39 GetUserLiveChannelTag DEPRECATED
- 4.8.40 GetUserLockedChannels DEPRECATED
- 4.8.41 GetLiveSchedule DEPRECATED
- 4.8.42 GetLiveSchedules DEPRECATED
- 4.8.43 GetDetailedLivePrograms DEPRECATED
- 4.8.44 GetLiveChannelDetailedPrograms DEPRECATED
- 4.8.45 GetLiveChannelUrl DEPRECATED
- 4.8.46 GetLiveChannelUrlList DEPRECATED
- 4.9 Event Service
- 4.10 Interest Service
- 4.11 Genre Service
- 4.12 Movie Service
- 4.12.1 GetAllMoviesCatalogItems DEPRECATED
- 4.12.2 GetAllSimpleMovies DEPRECATED
- 4.12.3 GetExtCatchUpURL DEPRECATED
- 4.12.4 GetMovie DEPRECATED
- 4.12.5 GetMovieCommercialOffers DEPRECATED
- 4.12.6 GetMovies DEPRECATED
- 4.12.7 GetSeasonEpisodeSimpleMovies DEPRECATED
- 4.12.8 GetSeriesSeasonSimpleMovies DEPRECATED
- 4.12.9 GetSubtitle
- 4.12.10 SearchProducts DEPRECATED
- 4.12.11 SearchSimpleMovies DEPRECATED
- 4.13 Network Pvr Service
- 4.14 Payment Service
- 4.15 InstanceParameter Service
- 4.16 GetKeyValues
- 4.17 Parameter Service
- 4.18 Person Service
- 4.19 Playback Service
- 4.19.1 CanWatchMedia
- 4.19.2 GetMediaUrl
- 4.19.3 GetMediaUrlsStb
- 4.19.4 GetMediaUrlStb
- 4.19.5 GetMovieResumeData
- 4.19.6 GetMovieResumesData
- 4.19.7 GetPlayReadyLicenseInfo
- 4.19.8 GetUserResumeData
- 4.19.9 GetUserItemsResumeData
- 4.19.10 PlaybackHeartBeatLive
- 4.19.11 PlaybackHeartBeatVod
- 4.19.12 PlaybackHeartBeatRecording
- 4.19.13 SetMovieResumeData
- 4.19.14 SetItemResumeData
- 4.20 Playlist Service
- 4.21 Purchase Service
- 4.21.1 CancelProduct
- 4.21.2 CancelPurchase
- 4.21.3 ConfirmPurchase
- 4.21.4 CreatePurchase
- 4.21.5 CreatePurchaseStb
- 4.21.6 GetActiveProductEndDate
- 4.21.7 GetActiveProductPurchaseStatus
- 4.21.8 GetAvailablePaymentMethods
- 4.21.9 GetAvailablePricingModels DEPRECATED
- 4.21.10 GetCreditCard
- 4.21.11 GetPricingModel DEPRECATED
- 4.21.12 GetProductName
- 4.21.13 GetWebpayPurchaseHtmlPage
- 4.21.14 ManageCreditCard
- 4.21.15 SetInstanceDeviceDefaultPayment
- 4.21.16 SetUserDefaultPayment
- 4.22 Registration Service
- 4.22.1 ChangePassword
- 4.22.2 DisableUser
- 4.22.3 EnableUser
- 4.22.4 GetAllTrustedDevices
- 4.22.5 GetApplicationToken
- 4.22.6 GetPairedApplications
- 4.22.7 GetRegistrationFields
- 4.22.8 GetTrustedDeviceChallengeCode
- 4.22.9 GetTrustedDevices
- 4.22.10 ModifyTrustedDevice
- 4.22.11 ModifyUser
- 4.22.12 RegisterTrustedDevice
- 4.22.13 RegisterTrustedDeviceChallenge
- 4.22.14 RegisterUser
- 4.22.15 RemoveApplicationToken
- 4.22.16 RemoveTrustedDevice
- 4.22.17 RemoveUser
- 4.22.18 SendConfirmationEmail
- 4.22.19 SetMinimumAgeRating
- 4.23 Remote Pvr Service
- 4.23.1 AddRecordingDefinition DEPRECATED
- 4.23.2 GetProgramInfos DEPRECATED
- 4.23.3 GetRecordings DEPRECATED
- 4.23.4 GetStorageInfos DEPRECATED
- 4.23.5 RemoveCompletedRecordings DEPRECATED
- 4.23.6 RemoveRecordingDefinition DEPRECATED
- 4.23.7 RemoveUpcomingRecordings DEPRECATED
- 4.23.8 UpdateCompletedRecording DEPRECATED
- 4.23.9 UpdateOneTimeToSeries DEPRECATED
- 4.23.10 UpdateRecordingDefinition DEPRECATED
- 4.23.11 UpdateRecordingDefinitionPriorities DEPRECATED
- 4.23.12 UpdateUpcomingRecording DEPRECATED
- 4.24 Search Service
- 4.25 Subscription Service
- 4.25.1 GetAllInstanceServices DEPRECATED
- 4.25.2 GetAllSubscriptions DEPRECATED
- 4.25.3 GetAllSubscriptionsCatalogItems DEPRECATED
- 4.25.4 GetMovieSubscriptions DEPRECATED
- 4.25.5 GetSubscription DEPRECATED
- 4.25.6 GetSubscriptionLiveChannels DEPRECATED
- 4.25.7 GetSubscriptionMovies DEPRECATED
- 4.25.8 GetSubscriptions DEPRECATED
- 4.25.9 GetSubscriptionServices DEPRECATED
- 4.25.10 GetStbSubscriptions DEPRECATED
- 4.25.11 GetSubscriptionChannels DEPRECATED
- 4.25.12 GetSubscriptionPlaylists DEPRECATED
- 4.26 Time Service
- 4.27 Timeshift Service
- 4.28 User Service
- 4.28.1 ChangePin
- 4.28.2 ChangePinFirstUse
- 4.28.3 CheckPin
- 4.28.4 DisablePin
- 4.28.5 EnablePin
- 4.28.6 GetDefaultOBPinNumber
- 4.28.7 GetFullView DEPRECATED
- 4.28.8 GetNextSerieEpisodeForUser
- 4.28.9 GetNodeRecommendations
- 4.28.10 GetNodeRecommendations DEPRECATED
- 4.28.11 GetMiniUserProducts DEPRECATED
- 4.28.12 GetRecoms DEPRECATED
- 4.28.13 GetRootRecommendationsByView DEPRECATED
- 4.28.14 GetRootRecommendationsCombined DEPRECATED
- 4.28.15 GetUser
- 4.28.16 GetUserAudioDefault
- 4.28.17 GetUserBundles DEPRECATED
- 4.28.18 GetUserBundlesCatalogItems DEPRECATED
- 4.28.19 GetUserChallengeCode
- 4.28.20 GetUserPlaylists DEPRECATED
- 4.28.21 GetUserPreference
- 4.28.22 GetUserProducts DEPRECATED
- 4.28.23 GetUserQueue DEPRECATED
- 4.28.24 GetUserRecommendations DEPRECATED GVP 3.0
- 4.28.25 GetUserRentedProducts DEPRECATED
- 4.28.26 GetUserRentedSimpleMovies DEPRECATED
- 4.28.27 GetUserRights
- 4.28.28 GetUserServices
- 4.28.29 GetUserSeasons DEPRECATED
- 4.28.30 GetUserSubscriptions DEPRECATED
- 4.28.31 GetUserSubscriptionsCatalogItems DEPRECATED
- 4.28.32 GetUserSubtitleDefault
- 4.28.33 GetUserTaggedProducts DEPRECATED
- 4.28.34 GetUserTaggedSimpleMovies DEPRECATED
- 4.28.35 GetUserTags
- 4.28.36 GetUserTimestamp
- 4.28.37 GetUserTimestamps
- 4.28.38 GetAuraId
- 4.28.39 GetAuraToken
- 4.28.40 GetUserWatchHistory DEPRECATED
- 4.28.41 GetUserWithEmail
- 4.28.42 LockedByMandatorySubscription
- 4.28.43 RemoveWatchHistory
- 4.28.44 SetUserAudioDefault
- 4.28.45 SetUserPreference
- 4.28.46 SetUserSubtitleDefault
- 4.28.47 TagProduct
- 4.28.48 TagItem
- 4.28.49 UntagProduct
- 4.28.50 UntagItem
- 4.28.51 GetItemsTags
- 4.28.52 UpdateUserFirstAccess
- 4.28.53 AcceptServicesAgreement
- 4.28.54 RemoveServicesAgreement
- 4.29 WebOnlyRegistration Service
- 4.1 Authentication Service
Introduction
This document includes basic API definitions for the UNI API, including protocols, method calling conventions, data exchange formats, methods, data objects and enumerations. It is assumed that the reader is familiar with the encoding of objects using JSON (http://www.json.org/). This document will use its notation when describing data results.
Overview
The API is exposed as a REST service. It receives the parameters through the URL and a query-string, and it returns response data using a JSON-encoded string. To ensure that only authorized clients can access the API, all operations require an identifier composed of a “ConsumerKey“ and “ConsumerSecret“, which are unique for each client application accessing the API. These are also be used to sign the URL using OAuth and HMAC-SHA1 signatures. Access to the API can only be performed through HTTP and HTTPS protocol. Different methods may accept both protocols, or may require the secure version.
URL Structure
Each service has a different root URL, such as: http://api_environment_url/AuthenticationService.svc/ http://api_environment_url/ChannelService.svc/ http://api_environment_url/MovieService.svc/
The service can use separate URLs for different services, to allow better load balancing of high-load methods. However, this feature is currently not being used. The URLs vary depending on the environment (dev, cert, preprod, prod) and the device type (there is load balancing at client level) It’s recommended that any application consuming the UNI API include a centralized and easy to update configuration for the service URLs, to simplify switching between development and production environments.
To access a method, the client application must construct the URL by appending the method name to the root URL, such as: http://api_environment_url/ChannelService.svc/GetChannel
Parameters are sent as part of the querystring: http://api_environment_url/ChannelService.svc/GetChannel?token=c2FtcGxlIHJlbmV3ZWQgdG9rZW4&channelId=102
The URL must then be signed using the method described in the OAuth Signature section. The API signature process can also be disabled for debugging purposes.
OAuth Signature
To prevent the usage of the API by unauthorized parties, all requests must be signed using a valid ConsumerKey/ConsumerSecret pair, using the HMAC-SHA1 signing method described by the OAuth 1.0 specification.
More details about OAuth can be found at: http://oauth.net/, where you can find also some implementations in different languages.
The ConsumerKey and ConsumerSecret vary depending on the environment and applications should not expose this information (at least the ConsumerSecret) outside the application as then the security would be compromised.
If you are starting to develop an application, please request your ConsumerSecret and ConsumerKey to be generated for the different environments by sending an email to gvp@tid.es.
Please notice that it is not required a complete implementation of the OAuth authentication protocol, only the signature algorithm to be applied to the requests. It’s important to remark that the “oauth_consumer_key” must be sent in every request, even if the API call does not required a signature.
A sample for the OAuth signature process can be found here
GET and POST Support
Depending on the API method, the use of the POST method may be required. When performing a call using POST, the device must:
- Generate the signature as if all the parameters were to be sent over query-string
- Send the entire data in the form body, using the same format as if the data was to be sent over a query-string
In other words, take this request:
- Method: GET
- URL: http://api_environment_url/ChannelService.svc/GetChannel?token=c2FtcGxlIHJlbmV3ZWQgdG9rZW4&channelId=102
- Body: <Empty String>
It can be sent as POST using this format:
- Method: POST
- URL: http://api_environment_url/ChannelService.svc/GetChannel
- Body:token=c2FtcGxlIHJlbmV3ZWQgdG9rZW4&channelId=102
Currently (as for GVP 2.4) don't require POST for any method request. GET can be used for all UNIAPI requests.
It is important to remark that the usage of url encode functions is recomendable for those parameters that might contain special characters.
Authentication
UNI API methods that require any kind of user identification or filtering require a Token parameter. This is necessary even for anonymous users. This token parameter is URL-safe, and doesn’t need to be url encoded before passing it through the request.
Currently, several authentication methods supported:
- Anonymous
- Username/Password
- ApplicationToken
- Trusted Device (DeviceId)
To use the Trusted Device authentication method, the device must first be linked to the user. The user can register the device through two different processes:
- Using the Website: Device requests a Challenge Code, that has to be entered in the website to allow device registration.
- Without using the Website: The device itself asks the user for the Username/Password, performs authentication, then request the registration of the DeviceId associated to this user account.
Regardless of which authentication method was used, the token has the same format and this token may be used for all other API methods.
The token has a time-based expiration, which is also be reported by the authentication methods.
A token renewal method (Renew) is also be available, and it’s recommended that the client device uses it to renew the token before expiration.
If any client accessing UNI API receives a “Expired Token” or “Invalid Token” error, it is be expected to start over the authentication process from one of the login methods.
Multi-Instance Support
Due to the need of having different content available to different countries, the authentication methods require an InstanceId parameter. An instance is an identification code for a country or group of countries that has a specific service settings.
This allow to use a single, shared database for all countries where the Product is deployed, even if parts of the video library are only available for a restricted subset of countries.
An instance also includes some default properties for that particular region, such as the default language. We call this Instance Settings
Multi-Platform Support
Inside an Instance, it is supported the concept of multiple “Platforms”, to allow the usage of different authentication/provisioning/billing platforms in the same Instance.
This option is only available only for Telefonica users. For non-Telefonica users the “platformId” is always equal to zero.
Starting from version 1.12, platform is no longer exposed through the UNI API, and it’s only used in the communication between the MIB backend and GAL (for OSS/BSS integration)
Multi-Language Support
All methods in the API support an LanguageId parameter informing in which language the metadata to be retrieved. It is also used to translate the status messages returned by the API. To simplify the notation it is omitted from the individual method specifications, but you can safely assume this parameter is present and is always accepted by all methods.
If the LanguageId parameter is omitted but a token parameter is present, the default language for the instance used in the authentication process is used. If neither of these parameters is present the API assumes the language to be English..
The LanguageId parameter, if present, has precedence over the token parameter, allowing a client application to override the default language for that particular instance.
Registration
The fields required by the registration process will be different depending on the instance in use. In order the support this, the device is expected to perform the following process when attempting to register an user:
- Obtain instance where the user will be registered, either by Geolocation or by requesting to the user directly
- Request from the API the list of fields to be used in the registration form
- Collect the information from the user
- Post the information to the API for user registration
The following fields are assumed to be the “minimum” that must be present in the registration form of all instances:
- First Name
- Last Name
- Password
- Repeat Password
- Adult Confirmation
- Mobile Number
- Birth Date
- Gender
TV Series Handling
A TV Series can be accessed in three different manners:
- By Series
- By Seasons
- By Episodes
In this API, all of these are also represented by the Movie object. The Type property identifies what type of object is being dealt with. All objects that return a list of movies also offer the possibility of filtering by type.
Playback can only be requested for an Episode. Series and Seasons are only used by navigation.
Purchase
The API is being designed assuming that the purchase process gives an instantaneous response. Non-Telefonica users can only make purchases from devices using credit already in their e-wallet.
Analytics
The analytics API is based on a generic “Event Collector” method. An event is defined of a unique string identifier and a well-defined JSON object including the properties for this particular event.
Developers working on client device implementations are encouraged to send events as often as possible, and are also encourage to propose additional events that would be helpful in monitoring the health of the platform, or would help diagnose problems with devices.
The event API has the “token” parameter marked as optional, however devices are required to send this parameter whenever available. Events without token should only happen on the very rare circumstances where the device has access to the API but cannot perfom any kind of authentication.
A section will list the events required by the platform, as well as the accompanying data structures.
Globalization and Culture Info
Dates and Times All dates and times will be reported by the service in the UTC (GMT) timezone. It’s the responsibility of the client application to adjust them to the user’s timezone before displaying. Values will be returned as posix time, which is defined as the number of number of seconds elapsed since the reference date of January 1st, 1970, 00:00 GMT. It’s recommended that both the server and the client applications use a Time Server to maintain its current time and timezone information up-to-date. We also recommend that all APIs implement a public, non-signed method informing the current time in the server.
Floating-Point Numbers All floating-point numbers (float/single, double, decimal/fixed) will use a dot (“.”) as a decimal separator. There will be no separator for thousands.
Strings All text will be encoded using UTF-8.
URL Whenever a URL is specified, will be an absolute URL including domain and full path.
TimeSpan All representations of elapsed time (movie length, rental duration) will be represented as an integer with the total of elapsed seconds.
Session Cookie generation
Until GVP 2.4, the load balancing sticky mode was being controlled through a cookie generated by the IIS. However, the IIS was not able to set the cookie domain name, and thus, the devices accessing through cross domain were not able to access this cookie. Due to this, those devices didn't send the cookie back in their requests, what caused the IIS to generate new cookies all the time and the sticky session was not effective. In GVP 2.4, this cookie generation has been implemented at UNIAPI level, which allows to set domain name in the response. This is configure in the UNIAPI configuration, at GvpApiConfig.mibconfig file.
- Set-Cookie:ASP.NET_SessionId=va5f2no2svtlfjpex5zhhth1; path=/; HttpOnly; domain: ucand.gvp.telefonica.com
Enumerations
AdultFilterType
AutoCompleteResultType
BundleStatus
CatalogItemType
CatalogType (openGvp)
ChannelContentType
CommercializationType
ContentCriteriaField
ContentCriteriaObject
ContentType (openGvp)
DeviceType
DRMType
ExtraMetadataType
Gender
GenreSearchType
HighlightType
HtmlType
ImageType
LinkType
MediaType
MovieAccessReason
MovieSearchType
MovieSortType
MovieType
PaymentType
PersonSearchType
PlaybackRight
PlaybackType
PlaylistStatus
PlayType
PriceType
ProductType
ProgramType
PurchaseStatus
Quality
QueueType
RecommendationType
RecordingScheduleState
RecurrenceType
RegistrationFieldType
RegistrationRequiredFieldType
ReminderType
Role
ServiceIdType
SlotType
SocialNetworkType
SortType
SortOrder
StatusCode
StreamingType
SubscriptionPurchaseType
SubscriptionStatus
SubscriptionType
TagType
TimeShiftStatus
TVTransport
UrlType
UserPinType
UserRecommendationsType
UserStatus
UserStorageType
UserStorageUnit
UserType
SimpleItem
Data Types
AccessReason
Instance
InstanceAgeRating
CatalogItem
Channel
ChannelCount
ChannelMap
ChannelMapLiveChannel
Distributor
EditorialContent
EpgLiveSchedule
EpgLiveChannel
EpgLiveProgram
EpgLiveProgramDetails
ExtraMetaData
Genre
Image
InstanceAgeRating
InstanceSettings
Language
LicenseInfo
LiveChannel
LiveChannelsPlayback
LiveChannelStreams
LiveProgram
LiveSchedule
LiveStream
Login
Media
MediaUrlResult
MiniAccessReason
MiniUserProduct
Movie
MovieStaff
OBPinDefault
Person
PersonalLiveChannel
PricingModel
Producer
Product
ProductTag
PurchaseResponse
QueueItem
RecordingSchedule
ReducedLiveSchedule
Region
RegistrationField
Result
Service
SimpleMovie
Subscription
SubtitleJSON
SubtitlesJSON
Tag
TransparentProvider
TrustedDevice
TrustedDeviceChallenge
TrustedDeviceList
TVTechnology
User
UserCustomField
UserPinStatus
UserProduct
UserQueue
UserSocialNetworkStatus
UserStorageInfo
UserTags
UserVideoServiceInfo
Services and methods
Authentication Service
BuildOIDCAuthRequest
BuildOIDCLogoutRequest
GetToolboxToken
LoginAnonymous
LoginApplicationToken
LoginRememberUser
LoginTrustedDevice
LoginUserCode
LoginUserHashCode
LoginUserPassword
LoginUserPasswordTEF
RecoverPassword
RecoverPasswordHash
RecoverPasswordLink
RememberUser
Renew
AutoComplete Service
SearchAutoComplete DEPRECATED
Bundle Service
GetAllBundles DEPRECATED
GetBundle DEPRECATED
GetBundleCatalogItems DEPRECATED
GetBundleMovies DEPRECATED
GetBundles DEPRECATED
GetMovieBundles DEPRECATED
Channel Service
GetAllChannels DEPRECATED
GetCatalogItems DEPRECATED
GetChannel DEPRECATED
GetChannelCatalogItems DEPRECATED
GetChannelChildren DEPRECATED
GetChannelEditorialContents DEPRECATED
GetChannels DEPRECATED
GetChannelSimpleMoviesCount DEPRECATED
GetChannelSimpleProductsCount DEPRECATED
GetLiveChannelCommercialOffers DEPRECATED
GetChannelHighlights DEPRECATED
GetChannelSimpleMovies DEPRECATED
GetChannelSimpleProducts DEPRECATED
GetChannelSimpleProductsStb DEPRECATED
GetChannelTopHighlights DEPRECATED
GetDetailedChannelProductsTree DEPRECATED
GetDetailedChannelTree DEPRECATED
GetTopRecommendedContents DEPRECATED
Configuration Service
GetInstance
GetInstanceID
GetInstances
GetInstanceSettings
GetLanguages
GetVersion
Content Criteria Service
GetContentSelection DEPRECATED
Dictionary Service
GetDictionary
Epg Service
GetActiveLiveChannels DEPRECATED
GetAESKey
GetAllLiveChannels DEPRECATED
GetChannelAvailableStreams DEPRECATED
GetChannelMap
GetChannelMapLiveChannels DEPRECATED
GetDetailedLiveChannelsSchedule DEPRECATED
GetDetailedLiveChannelsSchedules DEPRECATED
GetDetailedLiveProgram DEPRECATED
GetEpgVersion
GetLastViewedLiveChannelId
GetLiveChannel DEPRECATED
GetLiveChannelByCallLetter DEPRECATED
GetLiveChannelCommercialOffers DEPRECATED
GetLiveChannelsCatalogItems DEPRECATED
GetLiveChannelsPlayback DEPRECATED
GetLiveChannelsReducedLiveSchedules DEPRECATED
GetLiveChannelsReducedLiveSchedulesByGenre DEPRECATED
GetLiveChannelsReducedLiveSchedulesSortedByRating DEPRECATED
GetLiveChannelsSchedules DEPRECATED
GetLiveProgramSchedules DEPRECATED
GetLiveProgramSchedulesWithDate DEPRECATED
GetLiveSchedulesById DEPRECATED
GetPersonalLiveChannels DEPRECATED
GetRegions
GetSeriesSchedules
GetTVTechnologiesByRegion
GetUserAvailableStreams DEPRECATED
GetUserChannelMap
GetUserFavoriteLiveChannels
GetUserLiveChannels DEPRECATED
GetUserLiveChannelsPlayback DEPRECATED
SetLastViewedLiveChannel
SetUserLiveChannelTag
GetLiveProgramsScheduleBlock DEPRECATED
GetLiveChannelsSchedule DEPRECATED
GetLiveChannelsScheduleBlock DEPRECATED
GetLiveChannelPrograms DEPRECATED
GetUserLiveChannelTag DEPRECATED
GetUserLockedChannels DEPRECATED
GetLiveSchedule DEPRECATED
GetLiveSchedules DEPRECATED
GetDetailedLivePrograms DEPRECATED
GetLiveChannelDetailedPrograms DEPRECATED
GetLiveChannelUrl DEPRECATED
GetLiveChannelUrlList DEPRECATED
Event Service
AddEvent DEPRECATED
AddEventBatch
AddEventPerformsAction DEPRECATED
AddEventPlayback DEPRECATED
Interest Service
GetInstanceInterests
GetUserInterests
ManageUserInterests
Genre Service
GetAllGenres DEPRECATED
GetGenre DEPRECATED
GetGenres DEPRECATED
GetGenreSimpleMovies DEPRECATED
SearchGenres DEPRECATED
Movie Service
GetAllMoviesCatalogItems DEPRECATED
GetAllSimpleMovies DEPRECATED
GetExtCatchUpURL DEPRECATED
GetMovie DEPRECATED
GetMovieCommercialOffers DEPRECATED
GetMovies DEPRECATED
GetSeasonEpisodeSimpleMovies DEPRECATED
GetSeriesSeasonSimpleMovies DEPRECATED
GetSubtitle
SearchProducts DEPRECATED
SearchSimpleMovies DEPRECATED
Network Pvr Service
AddRecordingSchedule
CancelRecordingSchedule
DeleteRecordingSchedule
GetAllRecordingSchedules
GetRecordingSchedule
GetUserStorageInfo
SetUserRecordingPin
GetRecordingUrl
ProtectRecording
Payment Service
GetInstanceCredits
GetPaymentSettings
InstanceParameter Service
GetKeyValues
Parameter Service
GetKeyValues DEPRECATED
Person Service
GetAllPersons DEPRECATED
GetPerson DEPRECATED
GetPersonProducts DEPRECATED
GetPersons DEPRECATED
SearchPersons DEPRECATED
GetPersonSimpleMovies DEPRECATED
Playback Service
CanWatchMedia
GetMediaUrl
GetMediaUrlsStb
GetMediaUrlStb
GetMovieResumeData
GetMovieResumesData
GetPlayReadyLicenseInfo
GetUserResumeData
GetUserItemsResumeData
PlaybackHeartBeatLive
PlaybackHeartBeatVod
PlaybackHeartBeatRecording
SetMovieResumeData
SetItemResumeData
Playlist Service
GetAllPlaylists DEPRECATED
GetAllPlaylistsTimeStamp DEPRECATED
GetMoviePlaylists DEPRECATED
GetPlaylist DEPRECATED
GetPlaylistMovies DEPRECATED
GetPlaylists DEPRECATED
Purchase Service
CancelProduct
CancelPurchase
ConfirmPurchase
CreatePurchase
CreatePurchaseStb
GetActiveProductEndDate
GetActiveProductPurchaseStatus
GetAvailablePaymentMethods
GetAvailablePricingModels DEPRECATED
GetCreditCard
GetPricingModel DEPRECATED
GetProductName
GetWebpayPurchaseHtmlPage
ManageCreditCard
SetInstanceDeviceDefaultPayment
SetUserDefaultPayment
Registration Service
ChangePassword
DisableUser
EnableUser
GetAllTrustedDevices
GetApplicationToken
GetPairedApplications
GetRegistrationFields
GetTrustedDeviceChallengeCode
GetTrustedDevices
ModifyTrustedDevice
ModifyUser
RegisterTrustedDevice
RegisterTrustedDeviceChallenge
RegisterUser
RemoveApplicationToken
RemoveTrustedDevice
RemoveUser
SendConfirmationEmail
SetMinimumAgeRating
Remote Pvr Service
AddRecordingDefinition DEPRECATED
GetProgramInfos DEPRECATED
GetRecordings DEPRECATED
GetStorageInfos DEPRECATED
RemoveCompletedRecordings DEPRECATED
RemoveRecordingDefinition DEPRECATED
RemoveUpcomingRecordings DEPRECATED
UpdateCompletedRecording DEPRECATED
UpdateOneTimeToSeries DEPRECATED
UpdateRecordingDefinition DEPRECATED
UpdateRecordingDefinitionPriorities DEPRECATED
UpdateUpcomingRecording DEPRECATED
Search Service
SearchContent DEPRECATED
Subscription Service
GetAllInstanceServices DEPRECATED
GetAllSubscriptions DEPRECATED
GetAllSubscriptionsCatalogItems DEPRECATED
GetMovieSubscriptions DEPRECATED
GetSubscription DEPRECATED
GetSubscriptionLiveChannels DEPRECATED
GetSubscriptionMovies DEPRECATED
GetSubscriptions DEPRECATED
GetSubscriptionServices DEPRECATED
GetStbSubscriptions DEPRECATED
GetSubscriptionChannels DEPRECATED
GetSubscriptionPlaylists DEPRECATED
Time Service
GetTime
Timeshift Service
GetCurrentInstanceChannelSet
GetCurrentUserChannelSet
GetInstanceChannelSet
GetInstanceData
GetUserChannelSet
GetUserData
GetUserStatus
NewTermsAccepted
UserActivation
UserDeactivation
UserMaxCapacityReached
User Service
ChangePin
ChangePinFirstUse
CheckPin
DisablePin
EnablePin
GetDefaultOBPinNumber
GetFullView DEPRECATED
GetNextSerieEpisodeForUser
GetNodeRecommendations
GetNodeRecommendations DEPRECATED
GetMiniUserProducts DEPRECATED
GetRecoms DEPRECATED
GetRootRecommendationsByView DEPRECATED
GetRootRecommendationsCombined DEPRECATED
GetUser
GetUserAudioDefault
GetUserBundles DEPRECATED
GetUserBundlesCatalogItems DEPRECATED
GetUserChallengeCode
GetUserPlaylists DEPRECATED
GetUserPreference
GetUserProducts DEPRECATED
GetUserQueue DEPRECATED
GetUserRecommendations DEPRECATED GVP 3.0
GetUserRentedProducts DEPRECATED
GetUserRentedSimpleMovies DEPRECATED
GetUserRights
GetUserServices
GetUserSeasons DEPRECATED
GetUserSubscriptions DEPRECATED
GetUserSubscriptionsCatalogItems DEPRECATED
GetUserSubtitleDefault
GetUserTaggedProducts DEPRECATED
GetUserTaggedSimpleMovies DEPRECATED
GetUserTags
GetUserTimestamp
GetUserTimestamps
GetAuraId
GetAuraToken
GetUserWatchHistory DEPRECATED
GetUserWithEmail
LockedByMandatorySubscription
RemoveWatchHistory
SetUserAudioDefault
SetUserPreference
SetUserSubtitleDefault
TagProduct
TagItem
UntagProduct
UntagItem
GetItemsTags
UpdateUserFirstAccess
AcceptServicesAgreement
RemoveServicesAgreement