Difference between revisions of "Service"

From Gvp-public
Jump to navigation Jump to search
(Created page with " {{Api_DataType_Spec |Description= ==== <span style="color:#7DC04E">THIS DATA TYPE IS A DRAFT FOR GVP 2.4</span> ==== Represents a Service object. Services provide access to an s...")
 
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
 
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
 
|Description=
 
|Description=
−
==== <span style="color:#7DC04E">THIS DATA TYPE IS A DRAFT FOR GVP 2.4</span> ====
+
Represents a Service object. Services provide access to an specific feature such as nPVR, RestartTV (Timeshift), etc.  
−
Represents a Service object. Services provide access to an specific feature such as rPVR, nPVR, RestarTV, etc.  
+
Services are not purchased standalone, they are always commercialized inside [[Subscriptions]].
−
Services are not purchased standalone, they are always commercialized inside [[Subscriptions]]
+
 
  
 
|Members=
 
|Members=
Line 19: Line 18:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Title
+
! Name
 
{{!}} String
 
{{!}} String
−
{{!}} The title for the subscription that will be shown to end users
+
{{!}} The name for the Service
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! Description
 
! Description
 
{{!}} String
 
{{!}} String
−
{{!}} A long description of the subscription that will be shown to end users.
+
{{!}} A long description of the Service that will be shown to end users.  
−
{{!}}- valign="top"
 
−
 
 
−
! ShortDescription
 
−
{{!}} String
 
−
{{!}} A short description of the subscription that will be shown to end users.  
 
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! DateStart
+
! ServiceTypeId
 
{{!}} int
 
{{!}} int
−
{{!}} The commercialization start date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
+
{{!}} The value for the [[ServiceType]] enum that indicates the type of service.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! DateEnd
+
! ServiceTypeName
−
{{!}} int
+
{{!}} String
−
{{!}} The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
+
{{!}} The name for the Service Type
−
{{!}}- valign="top"
 
−
 
 
−
! Icon
 
−
{{!}} [[Image]] object
 
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
 
−
{{!}}- valign="top"
 
−
 
 
−
! Banner
 
−
{{!}} [[Image]] object
 
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
 
−
{{!}}- valign="top"
 
−
 
 
−
! Type
 
−
{{!}} int
 
−
{{!}} Represents the subscription type (enumeration). See [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration for more information.
 
−
{{!}}- valign="top"
 
−
 
 
−
! Status
 
−
{{!}} int
 
−
{{!}} Represents the subscription status (enumeration). See [[UNIAPI_Specification#SubscriptionStatus| SubscriptionStatus]] enumeration for more information.
 
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! TrialDays
+
! InstanceId
 
{{!}} int
 
{{!}} int
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
+
{{!}} InstanceId
−
{{!}}- valign="top"
 
−
 
 
−
! Images
 
−
{{!}} Array of [[Image]] object
 
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.3, the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] should be used to perform dynamic resizing of images. For backwards compatibility, the resized images will be returned by providing the thumbox url for the images with the different sizes defined in GVP_IMAGE_PROFILE_PRODUCT_TYPE table in MIB.
 
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 80: Line 49:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Status
+
! RequiresUserAgreement
−
{{!}} int
+
{{!}} boolean
−
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
+
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''
 +
Indicates if the service needs to be accepted by the user before enjoy it
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Age Rating
+
! UserAgreementText
−
{{!}} [[AgeRating]] object
+
{{!}} string
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
+
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''  
 +
Text that will be shown in the agreement pop-up of the service
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Stars
+
! AgreementAccepted
−
{{!}} int
+
{{!}} string
−
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
+
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''  
 +
Only for GetUserServices Response, indicates if the user Has Accepted the user agreement
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Tags
 
−
{{!}} Array of  [[UserTags]] object
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! CanWatch
 
−
{{!}} [[CanWatch]] object
 
−
{{!}}  Indicates the grants of this subscription for the current user. Provides the information if the user owns this Subscription, the pricing model used, etc.
 
−
{{!}}- valign="top"
 
−
 
−
! CanAcquire
 
−
{{!}} bool
 
−
{{!}}  bgcolor="orange" {{!}} Indicates if the user is able to purchase this subscription. The logic for calculating this is based on.
 
−
{{!}}- valign="top"
 
−
 
−
! HaveVoDAccess
 
−
{{!}} bool
 
−
{{!}}  bgcolor="orange" {{!}} Same as CanAcquire property, but..
 
−
{{!}}- valign="top"
 
−
 
−
! ChildCount
 
−
{{!}} int
 
−
{{!}}  bgcolor="orange" {{!}}  Indicates the count of objects that this Subscription provides.
 
−
{{!}}- valign="top"
 
−
 
−
! DateIns
 
−
{{!}} int
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! MediaRoomSync
 
−
{{!}} bool
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! IsOtt
 
−
{{!}} bool
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! IsIptv
 
−
{{!}} bool
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! IsHybrid
 
−
{{!}} bool
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! UpdateSender
 
−
{{!}} bool
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! Upgrade
 
−
{{!}} Array of int
 
−
{{!}}  bgcolor="#7DC04E" {{!}} '''NEW IN 2.4'''. Returns an array of Subscription IDs that this Subscription has '''upgrade''''  relationship with.
 
−
{{!}}- valign="top"
 
−
 
−
! Incompatible
 
−
{{!}} Array of int
 
−
{{!}}  bgcolor="#7DC04E" {{!}} '''NEW IN 2.4'''. Returns an array of Subscription IDs that this Subscription has '''incompatible'''' relationship with.
 
−
{{!}}- valign="top"
 
−
 
−
! RequiredDays
 
−
{{!}} int
 
−
{{!}}  bgcolor="#7DC04E" {{!}} '''NEW IN 2.4'''. Number of days since the purchase that the user will not be able to perform upgrade operations having this subscription purchased until the time passes. Applications should use this information combined with [[CanWatch]] information to block users from purchasing subscriptions that have upgrade relationship with a Subscription that has not passed the required days.
 
−
{{!}}- valign="top"
 
  
 
{{!}}}
 
{{!}}}
Line 169: Line 72:
  
 
|Example=
 
|Example=
−
 
+
<syntaxhighlight lang="javascript">
 
{
 
{
−
:        "ID": 51,
+
        "ID": 51,
−
:        "Title": "GVP2.0_RFA_SG_TSA",
+
        "Name": "nPVR Service",
−
:        "Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
+
        "Description": "Description for nPVR Service",
−
:        "ShortDescription": "Short description about this purchase",
+
        "ServiceTypeId": 1,
−
:        "DateStart": 1339538400,
+
        "ServiceTypeName": "Global service",
−
:        "DateEnd": 1434751200,
+
        "InstanceId": 14,
−
:        "Type": 1,
+
        "ResizableImages": [Array of Images],
−
:        "Status": 1,
+
        "RequiresUserAgreement": true,
−
:        "TrialDays": 0,
+
        "UserAgreementText": "This Service grant access to nPVR recordings service, do you agree to keep network recorded copies of your contents?"
−
:        "Images": [
 
−
::          Array of [[Image]] object
 
−
:        ],
 
−
:        "ResizableImages": [
 
−
::          Array of [[Image]] object
 
−
:        ],
 
−
:        "PurchaseType": 3,
 
−
:        "CanWatch": {
 
−
::            [[CanWatch]] Object
 
−
:        },
 
−
:        "CanAcquire": true,
 
−
:        "HaveVoDAccess": true,
 
−
:        "ChildCount": 1,
 
−
:        "IsOtt": true,
 
−
:        "IsIptv": false,
 
−
:        "IsHybrid": false,
 
−
:        "Upgrade": [13,14],
 
−
:        "Incompatible": [12,32,43,54,55],
 
−
:        "RequiredDays": 45,
 
 
}
 
}
 +
</syntaxhighlight >
 +
 +
|KnownIssues=
 +
[[ServicesUsage|Hot to Use Services]]
  
  
−
|KnownIssues=
 
−
None
 
 
|VersionHistory=
 
|VersionHistory=
 
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"  
 
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"  
Line 211: Line 97:
 
! Changes author
 
! Changes author
 
{{!}}- valign="top"
 
{{!}}- valign="top"
−
! 1.0
+
! 2.4
−
{{!}} Initial data type implementation
+
{{!}} New object. Initial design.
−
{{!}} Harley Cabral
+
{{!}} Jose A. Jimenez
 
{{!}}- valign="top"
 
{{!}}- valign="top"
−
! 2.3
+
! 4.1
−
{{!}} ResizableImages object added (for Thumbox resizing)
+
{{!}} Agreements.
−
{{!}} Francisco Milagro
+
{{!}} José Manuel Escartín
−
{{!}}- valign="top"
 
−
! 2.4
 
−
{{!}} Deprecated some member fields:
 
−
* Icon
 
−
* Banner
 
−
* TrialDays
 
−
* Images
 
−
* AgeRating
 
−
* Stars
 
−
* Tags
 
−
* DateIns
 
−
* MediaRoomSync
 
−
* IsOtt
 
−
* IsIptv
 
−
* IsHybrid
 
−
* UpdateSender
 
−
{{!}} Francisco Milagro
 
 
{{!}}}
 
{{!}}}
  
Line 240: Line 109:
 
* [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration
 
* [[UNIAPI_Specification#SubscriptionType|SubscriptionType]] enumeration
 
* [[UNIAPI_Specification#SubscriptionStatus|SubscriptionStatus]] enumeration
 
* [[UNIAPI_Specification#SubscriptionStatus|SubscriptionStatus]] enumeration
−
* [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration
 
−
* [[Image]] object
 
−
* [[CanWatch]] object
 
 
* [[UNIAPI_Specification#SubscriptionService|SubscriptionService]] methods
 
* [[UNIAPI_Specification#SubscriptionService|SubscriptionService]] methods
 
* [[UNIAPI_Specification#ThumboxService| Thumbox Service]] for image resizing
 
* [[UNIAPI_Specification#ThumboxService| Thumbox Service]] for image resizing
 
}}
 
}}

Latest revision as of 15:33, 28 November 2017

Represents a Service object. Services provide access to an specific feature such as nPVR, RestartTV (Timeshift), etc. Services are not purchased standalone, they are always commercialized inside Subscriptions.

Members

Field Data Type Description
ID int Unique identifier for the Service
Name String The name for the Service
Description String A long description of the Service that will be shown to end users.
ServiceTypeId int The value for the ServiceType enum that indicates the type of service.
ServiceTypeName String The name for the Service Type
InstanceId int InstanceId
ResizableImages Array of Image object NEW IN 2.3!

It provides the list of original images (non resized) associated with this Subscription. The application should use the Thumbox Service to perform dynamic resizing of the images in order to adapt them to the User Interface.

RequiresUserAgreement boolean NEW IN 4.1!

Indicates if the service needs to be accepted by the user before enjoy it

UserAgreementText string NEW IN 4.1!

Text that will be shown in the agreement pop-up of the service

AgreementAccepted string NEW IN 4.1!

Only for GetUserServices Response, indicates if the user Has Accepted the user agreement


Example

{
        "ID": 51,
        "Name": "nPVR Service",
        "Description": "Description for nPVR Service",
        "ServiceTypeId": 1,
        "ServiceTypeName": "Global service",
        "InstanceId": 14,
        "ResizableImages": [Array of Images],
        "RequiresUserAgreement": true,
        "UserAgreementText": "This Service grant access to nPVR recordings service, do you agree to keep network recorded copies of your contents?"
}


Known issues

Hot to Use Services


Version history

API Version Number Change description Changes author
2.4 New object. Initial design. Jose A. Jimenez
4.1 Agreements. José Manuel Escartín


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=Service&oldid=2432"