Id02039 at 08:00, 31 March 2016

2016-03-31T08:00:09Z

Id02039 at 11:52, 2 March 2016

2016-03-02T11:52:50Z

Id02039 at 11:50, 2 March 2016

2016-03-02T11:50:04Z

Id02256 at 12:57, 19 September 2014

2014-09-19T12:57:40Z

Id02256 at 12:57, 19 September 2014

2014-09-19T12:57:18Z

Id02256 at 21:01, 1 July 2014

2014-07-01T21:01:58Z

Id02256: Created page with "{{Api_DataType_Spec |Description=Represents the list of settings for a certain instance. These are the common configurations for a certain service and OB. Using this settings, th..."

2014-06-02T11:03:08Z

Created page with "{{Api_DataType_Spec |Description=Represents the list of settings for a certain instance. These are the common configurations for a certain service and OB. Using this settings, th..."

New page

{{Api_DataType_Spec
|Description=Represents the list of settings for a certain instance. These are the common configurations for a certain service and OB. Using this settings, the OB can customize the service setup.

|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"

! Title
{{!}} String
{{!}} Instance name
{{!}}- valign="top"

! RootChannelId
{{!}} int
{{!}} The root navigation channel ID for OTT devices. This ID can be used to build the Navigation channel tree.
{{!}}- valign="top"

! HeartbeatFrequency
{{!}} int
{{!}} HeartbeatFrequency
{{!}}- valign="top"

! BatchFrequency
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
{{!}}- valign="top"

! DeviceRegistrationUrl
{{!}} String
{{!}} The url for the web application registration form
{{!}}- valign="top"

! DisallowedEvents
{{!}} Array
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
{{!}}- valign="top"

! AgeRatings
{{!}} Array of [[AgeRating]] objects
{{!}} The Age Ratings associated with this instance.
{{!}}- valign="top"

! HeaderLinks
{{!}} Array of [[Link]] objects
{{!}} The header links associated with this instance
{{!}}- valign="top"

! FooterLinks
{{!}} Array of [[Link]] objects
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
{{!}}- valign="top"

! BackgroundImages
{{!}} Array of [[Image]] objects
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
{{!}}- valign="top"

! LogoImages
{{!}} Array of [[Image]] objects
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
{{!}}- valign="top"

! RegistrationMessage
{{!}} String
{{!}} Contains the message to be shown to end user to register
{{!}}- valign="top"

! RegistrationPhone
{{!}} String
{{!}} Contains the phone number to be shown to end user to register (Call center)
{{!}}- valign="top"

! UserRegistrationUrl
{{!}} String
{{!}} Contains the url for registering in the service (can be an external or internal URL)
{{!}}- valign="top"

! SupportedUserTypes
{{!}} Int
{{!}} Contais a value of the supported User types ([[UserType]] enum) in this instance (for registration purposes mainly).
{{!}}- valign="top"

! SpeedTestImageUrl
{{!}} String
{{!}} Url of the image to perform a speed test (used by Connected TVs)
{{!}}- valign="top"

! MandatorySubscriptionId
{{!}} int
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. ID of the mandatory Subscription for this instance. This concept is deprecated since GVP 2.4.
{{!}}- valign="top"

! MandatorySubscriptionMessage
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Message to be show to the end user when the user tries to purchase a subscription and has not purchased the mandatory subscription. This concept is deprecated since GVP 2.4.
{{!}}- valign="top"

! MandatoryRegistrationText
{{!}} [[HTML]] object
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. HTML to show in the page for purchasing the mandatory subscription. This is a HTML [[HTMLType]] enum= 1. This concept is deprecated since GVP 2.4.
{{!}}- valign="top"

! RegistrationText
{{!}} [[HTML]] object
{{!}} HTML to show in the page for User Registration mandatory subscription. This is a HTML [[HTMLType]] enum= 2.
{{!}}- valign="top"

! RegistrationImages
{{!}} Array of [[Image]] objects
{{!}} Images for registration page in PC.
{{!}}- valign="top"

! UseCallCenterForTefUserRegistration
{{!}} bool
{{!}} Indicates if the Telefonica user types should register using call center or registration page.
{{!}}- valign="top"

! AgeRatingSystem
{{!}} String
{{!}} Name of the AgeRating System, used in Mediaroom.
{{!}}- valign="top"

! CMGConnectorEndPoint
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Url of the CMG connector endpoint of this instance (for MR communication). This information should not be exposed in UNIAPI.
{{!}}- valign="top"

! CustomizationCssPath
{{!}} String
{{!}} Url of the Css to customize PC client.
{{!}}- valign="top"

! LicenseIssuerUrl
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Url of Widevine license issuer. This setting is deprecated since GVP 2.4.
{{!}}- valign="top"

! EmmUrl
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Url of Widevine Emm server. This setting is deprecated since GVP 2.4.
{{!}}- valign="top"

! SignonUrl
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Url of Widevine singon server. This setting is deprecated since GVP 2.4.
{{!}}- valign="top"

! Portal
{{!}} String
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Widevine portal setting. This setting is deprecated since GVP 2.4.
{{!}}- valign="top"

! LegalConditions
{{!}} [[HTML]] object
{{!}} HTML to show in the PC for legal conditions. This is a HTML [[HTMLType]] enum= 3.
{{!}}- valign="top"

! CountryCodes
{{!}} Array of Strings
{{!}} Array of strings containing the country codes (COUNTRIES) associated with this instance. The code is in the ISO-3166 format.
{{!}}- valign="top"

! DisableContactus
{{!}} bool
{{!}} Indicates if the contact us page should be shown to the users or not for this instance
{{!}}- valign="top"

! RecoverPasswordEmailFrom
{{!}} String
{{!}} Email to be used in the FROM field of password recovery emails
{{!}}- valign="top"

! PurchaseEmailFrom
{{!}} String
{{!}} Email to be used in the FROM field of purchase notification emails
{{!}}- valign="top"

! RegistrationEmailFrom
{{!}} String
{{!}} Email to be used in the FROM field of registration notification emails
{{!}}- valign="top"

! Copyright
{{!}} String
{{!}} Service Copyright to be displayed in the applications
{{!}}- valign="top"

! GalNonDelegateAuthenticationFlag
{{!}} bool
{{!}} Flag that indicates if the instance has NonDelegatedAuthentication enabled or not.
{{!}}- valign="top"

! SiteTitle
{{!}} String
{{!}} Title for the website
{{!}}- valign="top"

! EnablePlaylists
{{!}} bool
{{!}} Indicates if the instance has Playlist enabled or not
{{!}}- valign="top"

! MinimumAgeForRegistration
{{!}} int
{{!}} Integer with the minimum age for user registration. If the user indicates an age lower than this, the registration will be blocked.
{{!}}- valign="top"

! RootIptvChannelId
{{!}} int
{{!}} Channel ID root for IPTV VOD Channel tree
{{!}}- valign="top"

! MaxConcurrentPlaybackStreams
{{!}} int
{{!}} Maximun number of concurrent playback sessions allowed in this instance (Concurrence control)
{{!}}- valign="top"

! ConcurrentAdditionalDeviceBehaviour
{{!}} int
{{!}} Indicates the Concurrent Session control behavior (kick oldest 1 / kick newest 0). See [[ConcurrentAdditionalDeviceBehaviour]] enum.
{{!}}- valign="top"

! PlaybackHeartbeatInterval
{{!}} int
{{!}} Heartbeat interval for Playback. Determines the frequency that the player should send heartbeat during playback.
{{!}}- valign="top"

! PlaybackHeartbeatInterval
{{!}} int
{{!}} Heartbeat interval for Playback. Determines the frequency that the player should send heartbeat during playback.
{{!}}- valign="top"

! EnableLiveOtt
{{!}} bool
{{!}} Indicates if the instance has LiveOTT enabled.
{{!}}- valign="top"

! FooterScripts
{{!}} String
{{!}} Contains the footer scripts code for Web client
{{!}}- valign="top"

! ExternalLandingPage
{{!}} String
{{!}} Indicates the External Landing Page url for embedding it into PC client
{{!}}- valign="top"

! ExternalLandingPageHeight
{{!}} int
{{!}} Height in pixels of the External landing page header
{{!}}- valign="top"

! GooglePlayUrl
{{!}} String
{{!}} URL of the google play store for Android application
{{!}}- valign="top"

! AppleStoreId
{{!}} int
{{!}} ID of the apple store item
{{!}}- valign="top"

! AppleStoreUrl
{{!}} String
{{!}} URL of the apple store for iOS application
{{!}}- valign="top"

! EnableDtp
{{!}} bool
{{!}} Indicates if the instance has Download to Play functionality enabled
{{!}}- valign="top"

! RootCatchupId
{{!}} int
{{!}} Channel ID root for Catchup Channel tree
{{!}}- valign="top"

! TimeShiftDeferralTime
{{!}} int
{{!}} Deferral time for time shift functionality
{{!}}- valign="top"

! TimeShiftCapacity
{{!}} int
{{!}} Maximum number of users allowed for Timeshift in this instance
{{!}}- valign="top"

! ThumbBoxUrl
{{!}} int
{{!}} Channel ID root for Catchup Channel tree
{{!}}- valign="top"

! EnableTimeShift
{{!}} int
{{!}} Channel ID root for Catchup Channel tree
{{!}}- valign="top"

{{!}}}

|Example=

<syntaxhighlight lang="javascript">
{
"Title": "Homolog",
"RootChannelId": 43,
"HeartbeatFrequency": 500,
"BatchFrequency": 60000,
"DeviceRegistrationUrl": "http://ottpre.labs.gvp.telefonica.com/",
"DisallowedEvents": [],
"AgeRatings": [
{
"ID": 3,
"Title": "G",
"Name": "G",
"Icon": {
"ID": 119,
"Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/119_8A9FC9B6E01FCCB2.png",
"Width": 75,
"Height": 75,
"Type": 4,
"Ext": ".png"
},
"Age": 0,
"IsAdult": false
},
{
"ID": 145,
"Title": "L",
"Name": "Livre para todos os públicos",
"Icon": {
"ID": 27660,
"Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/02/27660_D9D4E5A1088951B6.png",
"Width": 80,
"Height": 80,
"Type": 1,
"Ext": ".png"
},
"Age": 1,
"IsAdult": false
}
],
"HeaderLinks": [
{
"ID": 3,
"Url": "http://www.prnewswire.com/news-releases/telefonica-and-moremagic-solutions-expand-international-recharge-of-movistar-mobile-phones-throughout-latin-america-84363322.html",
"Title": "Press Releases",
"Type": 1,
"Html": ""
},
{
"ID": 4,
"Url": "http://www.telefonica.com/en/home/jsp/home.jsp",
"Title": "HotSite",
"Type": 1,
"Html": ""
}
],
"BackgroundImages": [],
"LogoImages": [],
"RegistrationMessage": "",
"RegistrationPhone": "",
"CurrencyFormat": "$%1",
"UserRegistrationUrl": "http://ottpre.labs.gvp.telefonica.com/Home/Index?message=openregister",
"SupportedUserTypes": 3,
"SpeedTestImageUrl": "http://b5019.cdn.telefonica.com/5019/Speed_Test.jpg",
"MandatorySubscriptionId": 0,
"MandatorySubscriptionMessage": "Teste",
"MandatoryRegistrationText": {
"ID": 2,
"Name": "Mandatory Registration",
"Source": 1,
"Subject": "",
"HtmlType": 1,
"Language": 1,
"Html": "<h3>enjoy info</h3>\r\n<div class=\"info\">\r\n\t<h5>enjoy</h5>\r\n\t<p>\r\n\t\t<strong>Enjoy</strong>\r\n\t\tour videoclub cataloque, you will have all kind of contents, with a code in the case of adult content in order to minors cannot gain access.\r\n\t</p>\r\n\t<p>\r\n\t\tOur contents are available both\r\n\t\t<strong>HD</strong>\r\n\t\tand SD, in different languages and with different subtitles.\r\n\t</p>\r\n\t{0}\r\n</div>"
},
"RegistrationText": {
"ID": 1,
"Name": "Registration",
"Source": 1,
"Subject": "",
"HtmlType": 2,
"Language": 1,
"Html": "<h3>Register</h3>\r\n<div class=\"info\">\r\n\t<h5>enjoy</h5>\r\n\t<p>\r\n\t\t<strong>Enjoy</strong>\r\n\t\tour contents are available both <strong>HD</strong> and <strong>SD</strong>, in different languages and with diferrent subtitles.\r\n\t</p>\r\n\t{0}\r\n</div>"
},
"RegistrationImages": [
{
"ID": 112,
"Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/112_A355D0ED83DDAAF9.jpg",
"Width": 250,
"Height": 200,
"Type": 7,
"Ext": ".jpg"
},
{
"ID": 236,
"Url": "http://media-pre.labs.gvp.telefonica.com/storagearea0/IMAGES/00/00/00/236_CFE327AE727524E9.png",
"Width": 250,
"Height": 200,
"Type": 7,
"Ext": ".png"
}
],
"UseCallCenterForTefUserRegistration": false,
"AgeRatingSystem": "MJBrasil",
"CMGConnectorEndPoint": "http://mrconnector1.ottpreprod.gvp.telefonica.com/",
"CustomizationCssPath": "https://posters-cert.labs.gvp.telefonica.com/storagearea0/GVP_WEB/css/skin_movistar_spain_2_2_1.css",
"LicenseIssuerUrl": "",
"EmmUrl": "",
"LogUrl": "",
"SignonUrl": "",
"Portal": "",
"LegalConditions": {
"ID": 72,
"Name": "Legal Condition Ottpre-labs",
"Source": 1,
"Subject": "",
"HtmlType": 3,
"Language": 1,
"Html": "<h3>\r\nLegal Condition\r\n</h3>"
},
"CountryCodes": [
"br",
"gb",
"xx",
"es",
"eu",
"--",
"il"
],
"DisableContactus": true,
"RecoverPasswordEmailFrom": "gvp@labone.net",
"PurchaseEmailFrom": "GVP_LabOne <gvp@labone.net>",
"RegistrationEmailFrom": "GVP_LabOne <gvp@labone.net>",
"Copyright": "© Telefonica Pre-Prod S.A.",
"GalNonDelegateAuthenticationFlag": true,
"GalAsynchronousCancellation": true,
"SiteTitle": "Pre-Prod Homolog",
"EnablePlaylists": true,
"MinimumAgeForRegistration": 0,
"RootIptvChannelId": 96,
"MaxConcurrentPlaybackStreams": 1,
"ConcurrentAdditionalDeviceBehaviour": 0,
"PlaybackHeartbeatInterval": 60,
"EnableLiveOtt": true,
"FooterScripts": "<script type=\"text/javascript\" src=\"https://d3skgb39wax964.cloudfront.net/TEFGVP/OTTAnalytics_TEFGVP_1_0_1.js\"></script>",
"ExternalLandingPage": "",
"ExternalLandingPageHeight": 0,
"GooglePlayUrl": "https://play.google.com/store/apps/details?id=com.tid.enjoy&hl=en",
"AppleStoreId": "665941149",
"EnableDtp": true,
"AppleStoreUrl": "https://itunes.apple.com/es/app/movistar-tv/id665941149",
"RootCatchupId": 0,
"TimeShiftDeferralTime": 0,
"TimeShiftCapacity": 10000,
"ThumbBoxUrl": "http://thumbbox-pre.labs.gvp.telefonica.com/Image/{RESIZE_TYPE}/{RETURN_TYPE}/w/{WIDTH}/h/{HEIGHT}?imageUrl={IMAGE_URL}",
"EnableTimeShift": true
}

</syntaxhighlight>

|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"

! 1.0
{{!}} Initial data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"

! 2.1
{{!}} Added new fields to the InstanceSettings object
* MaxConcurrentPlaybackStreams
* ConcurrentAdditionalDeviceBehaviour
* PlaybackHeartbeatInterval
* EnableLiveOtt

{{!}} Francisco Milagro
{{!}}- valign="top"

! 2.2
{{!}} Added new fields to the InstanceSettings object
* FooterScripts
* ExternalLandingPage
* GooglePlayUrl
* AppleStoreId
* EnableDtp
* AppleStoreUrl

{{!}} Francisco Milagro
{{!}}- valign="top"

! 2.3
{{!}} Added new fields to the InstanceSettings object
* RootCatchupId
* TimeShiftDeferralTime
* ThumbBoxUrl
* EnableTimeShift
{{!}} Francisco Milagro
{{!}}- valign="top"

! 2.4
{{!}} Deprecated some member fields:
* BatchFrequency
* DisallowedEvents
* FooterLinks
* BackgroundImages
* LogoImages
* MandatorySubscriptionId
* MandatorySubcriptionMessage
* CMGConnectorEndPoint
* LicenseIssuerUrl
* EmmUrl
* SignonUrl
* Portal
{{!}} Francisco Milagro
{{!}}}

|SeeAlso=
* [[UserType]] enumeration
* [[HTMLType]] enumeration
* [[ConcurrentAdditionalDeviceBehaviour]] enumeration
* [[Image]] object
* [[AgeRating]] object
* [[Link]] object
* [[HTML]] object
* [[GetInstanceSettings]] method
}}

@@ Line 305: / Line 305: @@
 ! AllowLoginBeforeConfirmation
 {{!}} boolean
-{{!}} If true, instance allows login before confirmation email.
+{{!}}  bgcolor=yellow {{!}} '''New in GVP 4.0'''.If true, instance allows login before confirmation email.
 {{!}}- valign="top"
 {{!}}}

@@ Line 535: / Line 535: @@
 * Portal
 {{!}} Francisco Milagro
 {{!}}}

@@ Line 303: / Line 303: @@
 {{!}}- valign="top"
 {{!}}}
@@ Line 464: / Line 468: @@
      "TimeShiftCapacity": 10000,
      "ThumbBoxUrl": "http://thumbbox-pre.labs.gvp.telefonica.com/Image/{RESIZE_TYPE}/{RETURN_TYPE}/w/{WIDTH}/h/{HEIGHT}?imageUrl={IMAGE_URL}",
-     "EnableTimeShift": true
+     "EnableTimeShift": true,
+}

@@ Line 130: / Line 130: @@
 ! CMGConnectorEndPoint
 {{!}} String
-{{!}} bgcolor="#FF2600" {{!}} Url of the CMG connector endpoint of this instance (for MR communication).
+{{!}} Url of the CMG connector endpoint of this instance (for MR communication).
 {{!}}- valign="top"

@@ Line 53: / Line 53: @@
 ! FooterLinks
 {{!}} Array of [[Link]] objects
-{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside
+{{!}} The footer links associated with this instance
 {{!}}- valign="top"

InstanceSettings - Revision history

Id02039 at 08:00, 31 March 2016

Id02039 at 11:52, 2 March 2016

Id02039 at 11:50, 2 March 2016

Id02256 at 12:57, 19 September 2014

Id02256 at 12:57, 19 September 2014

Id02256 at 21:01, 1 July 2014

Id02256: Created page with "{{Api_DataType_Spec |Description=Represents the list of settings for a certain instance. These are the common configurations for a certain service and OB. Using this settings, th..."