Difference between revisions of "Service"

From Gvp-public
Jump to navigation Jump to search
Line 48: Line 48:
 
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 2.3!'''  
 
{{!}} bgcolor="#7DC04E" {{!}} '''NEW IN 2.3!'''  
 
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"
 
−
 
−
! Status
 
−
{{!}} int
 
−
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
 
−
{{!}}- valign="top"
 
−
 
−
! Age Rating
 
−
{{!}} [[AgeRating]] object
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- valign="top"
 
−
 
−
! Stars
 
−
{{!}} int
 
−
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
−
{{!}}- 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"
 
{{!}}- valign="top"
  
Line 139: Line 54:
  
 
|Example=
 
|Example=
 +
<syntaxhighlight lang="javascript">
 +
{
 +
        "ID": 51,
 +
        "Name": "rPVR Service",
 +
        "Description": "Description for rPVR Service",
 +
        "ServiceType": 1,
 +
        "DateStart": 1339538400,
 +
        "DateEnd": 1434751200,
 +
        "ResizableImages": [Array of Images]
 +
}
 +
</syntaxhighlight >
  
 
{
 
{
 
:        "ID": 51,
 
:        "ID": 51,
−
:        "Title": "GVP2.0_RFA_SG_TSA",
+
:        "Name": "GVP2.0_RFA_SG_TSA",
 
:        "Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
 
:        "Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
 
:        "ShortDescription": "Short description about this purchase",
 
:        "ShortDescription": "Short description about this purchase",
Line 210: Line 136:
 
* [[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
 
}}
 
}}

Revision as of 16:39, 2 June 2014

THIS DATA TYPE IS A DRAFT FOR GVP 2.4

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.

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.
ServiceType int The value for the ServiceType enum that indicates the type of service.
DateStart int The commercialization start date (in Unix Timestamp) of the Service. Out of this time, the service cannot be purchased.
DateEnd int The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the service cannot be purchased.
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.


Example

{
        "ID": 51,
        "Name": "rPVR Service",
        "Description": "Description for rPVR Service",
        "ServiceType": 1,
        "DateStart": 1339538400,
        "DateEnd": 1434751200,
        "ResizableImages": [Array of Images]
}

{

"ID": 51,
"Name": "GVP2.0_RFA_SG_TSA",
"Description": "Description for GVP2.0_RFA_SG_TSA\r\nUsed for GVP2.0 RFA tets cases",
"ShortDescription": "Short description about this purchase",
"DateStart": 1339538400,
"DateEnd": 1434751200,
"Type": 1,
"Status": 1,
"TrialDays": 0,
"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,

}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation Harley Cabral
2.3 ResizableImages object added (for Thumbox resizing) Francisco Milagro
2.4 Deprecated some member fields:
  • Icon
  • Banner
  • TrialDays
  • Images
  • AgeRating
  • Stars
  • Tags
  • DateIns
  • MediaRoomSync
  • IsOtt
  • IsIptv
  • IsHybrid
  • UpdateSender
 Francisco Milagro


See also

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