Difference between revisions of "Subscription"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_DataType_Spec |Description=Represents a Subscription object. Subscriptions are packages that the user can purchase and provide access to other products such as Movies, Live...")
 
 
(9 intermediate revisions by 2 users not shown)
Line 72: Line 72:
 
! ResizableImages
 
! ResizableImages
 
{{!}} Array of [[Image]] object
 
{{!}} Array of [[Image]] object
−
{{!}} 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"
 
{{!}}- valign="top"
  
−
! Status
+
! PurchaseType
 
{{!}} int
 
{{!}} int
 
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
 
{{!}} Represents the Purchase Type of this subscription (BottomUp, TD or Both). See [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration for more information.
Line 82: Line 81:
  
 
! Age Rating
 
! Age Rating
−
{{!}} [[AgeRating]] object
+
{{!}} [[InstanceAgeRating]] object
 
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
Line 97: Line 96:
  
 
! CanWatch
 
! CanWatch
−
{{!}} [[CanWatch]] object
+
{{!}} [[AccessReason]] 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.
 
{{!}}  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"
 
{{!}}- valign="top"
Line 145: Line 144:
 
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
{{!}}  bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
 +
 +
! Upgrade
 +
{{!}} Array of int
 +
{{!}}  Returns an array of Subscription IDs that this Subscription has '''upgrade''''  relationship with.
 +
{{!}}- valign="top"
 +
 +
! Incompatible
 +
{{!}} Array of int
 +
{{!}}  Returns an array of Subscription IDs that this Subscription has '''incompatible'''' relationship with.
 +
{{!}}- valign="top"
 +
 +
! RequiredDays
 +
{{!}} int
 +
{{!}}  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"
 +
 +
! ExternalUrl
 +
{{!}} String
 +
{{!}}  bgcolor="#7DC04E" {{!}} '''New in GVP 3.0''' - Return an String with the External Url for device use as a subscription page.
 +
{{!}}- valign="top"
 +
 
{{!}}}
 
{{!}}}
  
Line 168: Line 188:
 
:        "PurchaseType": 3,
 
:        "PurchaseType": 3,
 
:        "CanWatch": {
 
:        "CanWatch": {
−
::            [[CanWatch]] Object
+
::            [[AccessReason]] Object
 
:        },
 
:        },
 
:        "CanAcquire": true,
 
:        "CanAcquire": true,
Line 176: Line 196:
 
:        "IsIptv": false,
 
:        "IsIptv": false,
 
:        "IsHybrid": false,
 
:        "IsHybrid": false,
 +
:        "Upgrade": [13,14],
 +
:        "Incompatible": [12,32,43,54,55],
 +
:        "RequiredDays": 45,
 +
:        "ExternalUrl": "http://www.tid.es",
 
}
 
}
  
Line 212: Line 236:
 
* UpdateSender
 
* UpdateSender
 
{{!}} Francisco Milagro
 
{{!}} Francisco Milagro
 +
{{!}}- valign="top"
 +
! 3.0
 +
{{!}} Add field to GVP 3.0
 +
* ExternalUrl
 +
{{!}} Ricardo Calvo
 +
{{!}}- valign="top"
 
{{!}}}
 
{{!}}}
  
Line 219: Line 249:
 
* [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration
 
* [[UNIAPI_Specification#SubscriptionPurchaseType|SubscriptionPurchaseType]] enumeration
 
* [[Image]] object
 
* [[Image]] object
−
* [[CanWatch]] object
+
* [[AccessReason]] 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 21:30, 23 March 2015

Represents a Subscription object. Subscriptions are packages that the user can purchase and provide access to other products such as Movies, Live Channels, Services, etc. The Subscription will always have a recurring pricing model associated.

Members

Field Data Type Description
ID int Unique identifier for the Subscription
Title String The title for the subscription that will be shown to end users
Description String A long description of the subscription that will be shown to end users.
ShortDescription String A short description of the subscription that will be shown to end users.
DateStart int The commercialization start date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
DateEnd int The commercialization end date (in Unix Timestamp) of the subscription. Out of this time, the subscription cannot be purchased.
Icon Image object DEPRECATED. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
Banner Image object DEPRECATED. Since GVP 2.4, this object will not be returned anymore. Only ResizableImages will be returned.
Type int Represents the subscription type (enumeration). See SubscriptionType enumeration for more information.
Status int Represents the subscription status (enumeration). See SubscriptionStatus enumeration for more information.
TrialDays int DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
Images Array of Image object DEPRECATED. Since GVP 2.3, the 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.
ResizableImages Array of Image object 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.
PurchaseType int Represents the Purchase Type of this subscription (BottomUp, TD or Both). See SubscriptionPurchaseType enumeration for more information.
Age Rating InstanceAgeRating object DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
Stars int DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
Tags Array of UserTags object DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
CanWatch AccessReason 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.
CanAcquire bool Indicates if the user is able to purchase this subscription. The logic for calculating this is based on.
HaveVoDAccess bool Same as CanAcquire property, but..
ChildCount int Indicates the count of objects that this Subscription provides.
DateIns int DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
MediaRoomSync bool DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
IsOtt bool DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
IsIptv bool DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
IsHybrid bool DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
UpdateSender bool DEPRECATED. Since GVP 2.4, this object will not be returned anymore inside Subcription object.
Upgrade Array of int Returns an array of Subscription IDs that this Subscription has upgrade' relationship with.
Incompatible Array of int Returns an array of Subscription IDs that this Subscription has incompatible' relationship with.
RequiredDays int 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.
ExternalUrl String New in GVP 3.0 - Return an String with the External Url for device use as a subscription page.


Example

{

"ID": 51,
"Title": "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": {
AccessReason Object
},
"CanAcquire": true,
"HaveVoDAccess": true,
"ChildCount": 1,
"IsOtt": true,
"IsIptv": false,
"IsHybrid": false,
"Upgrade": [13,14],
"Incompatible": [12,32,43,54,55],
"RequiredDays": 45,
"ExternalUrl": "http://www.tid.es",

}


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
3.0 Add field to GVP 3.0
  • ExternalUrl
 Ricardo Calvo


See also

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