Difference between revisions of "Service"

From Gvp-public
Jump to navigation Jump to search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==== <span style="color:#7DC04E">THIS DATA TYPE IS A DRAFT FOR GVP 2.4</span> ====
 
−
 
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
 
|Description=
 
|Description=
−
Represents a Service object. Services provide access to an specific feature such as rPVR, nPVR, RestarTV, etc.  
+
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]].
 
Services are not purchased standalone, they are always commercialized inside [[Subscriptions]].
  
Line 30: Line 28:
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! ServiceType
+
! ServiceTypeId
 
{{!}} int
 
{{!}} int
 
{{!}} The value for the [[ServiceType]] enum that indicates the type of service.
 
{{!}} The value for the [[ServiceType]] enum that indicates the type of service.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! DateStart
+
! ServiceTypeName
−
{{!}} int
+
{{!}} String
−
{{!}} The commercialization start date (in Unix Timestamp) of the Service. Out of this time, the service cannot be purchased.
+
{{!}} The name for the Service Type
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! DateEnd
+
! InstanceId
 
{{!}} int
 
{{!}} int
−
{{!}} The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the service cannot be purchased.
+
{{!}} InstanceId
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 50: Line 48:
 
It provides the list of original images (non resized) associated with this Subscription. The application should use the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] to perform dynamic resizing of the images in order to adapt them to the User Interface.
 
It provides the list of original images (non resized) associated with this Subscription. The application should use the [[UNIAPI_Specification#ThumboxService| Thumbox Service]] to perform dynamic resizing of the images in order to adapt them to the User Interface.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
 +
 +
! RequiresUserAgreement
 +
{{!}} boolean
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''
 +
Indicates if the service needs to be accepted by the user before enjoy it
 +
{{!}}- valign="top"
 +
 +
! UserAgreementText
 +
{{!}} string
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''
 +
Text that will be shown in the agreement pop-up of the service
 +
{{!}}- valign="top"
 +
 +
! AgreementAccepted
 +
{{!}} string
 +
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 4.1!'''
 +
Only for GetUserServices Response, indicates if the user Has Accepted the user agreement
 +
{{!}}- valign="top"
 +
  
 
{{!}}}
 
{{!}}}
Line 58: Line 75:
 
{
 
{
 
         "ID": 51,
 
         "ID": 51,
−
         "Name": "rPVR Service",
+
         "Name": "nPVR Service",
−
         "Description": "Description for rPVR Service",
+
         "Description": "Description for nPVR Service",
−
         "ServiceType": 1,
+
         "ServiceTypeId": 1,
−
         "DateStart": 1339538400,
+
         "ServiceTypeName": "Global service",
−
         "DateEnd": 1434751200,
+
         "InstanceId": 14,
−
         "ResizableImages": [Array of Images]
+
         "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?"
 
}
 
}
 
</syntaxhighlight >
 
</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 79: Line 99:
 
! 2.4
 
! 2.4
 
{{!}} New object. Initial design.
 
{{!}} New object. Initial design.
−
{{!}} Francisco Milagro
+
{{!}} Jose A. Jimenez
 +
{{!}}- valign="top"
 +
! 4.1
 +
{{!}} Agreements.
 +
{{!}} José Manuel Escartín
 
{{!}}}
 
{{!}}}
  

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"