Difference between revisions of "AccessReason"

From Gvp-public
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 11: Line 11:
  
 
! ExpirationDate
 
! ExpirationDate
{{!}}  
+
{{!}} long
{{!}}  
+
{{!}} A timestamp that represent a time what the permission to access will be expired.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! HaveMandatorySubscription
 
! HaveMandatorySubscription
{{!}}  
+
{{!}} bool
{{!}}  
+
{{!}} Set if the user already has the Mandatory Subscription or not. The mandatory is a prerequisite to get access for the product.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! MandatorySubscriptionId
 
! MandatorySubscriptionId
{{!}}  
+
{{!}} int
{{!}}  
+
{{!}} Represents what is the Mandatory Subscription for the currently instance.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! MandatorySubscriptionMessage
 
! MandatorySubscriptionMessage
{{!}}  
+
{{!}} String
{{!}}  
+
{{!}} A Message defined on MIB Tools by each OB per Instance. It can be used to show some message to customer on client device.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! MovieAccessReason
 
! MovieAccessReason
{{!}}  
+
{{!}} [[MovieAccessReason]]
{{!}}  
+
{{!}} Sets which kind of Access Right has the product.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! PricingModel
 
! PricingModel
{{!}}  
+
{{!}} [[PricingModel]] type
{{!}}  
+
{{!}} Sets the rules of pricing is applied for the product.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! ProductId
 
! ProductId
{{!}}  
+
{{!}} int
{{!}}  
+
{{!}} Represents the ID of the product that this object is reference.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! ProductTypeId
 
! ProductTypeId
{{!}}  
+
{{!}} [[ProductType]]
{{!}}  
+
{{!}} Type of the product reference.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! PurchaseStatus
 
! PurchaseStatus
{{!}}  
+
{{!}} [[PurchaseStatus]]
{{!}}  
+
{{!}} Represents the current status of the acquisition product.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! RentalHoursLeft
 
! RentalHoursLeft
{{!}}  
+
{{!}} int
 
{{!}}  
 
{{!}}  
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! SourceProductId
 
! SourceProductId
{{!}} String
+
{{!}} int
{{!}}  
+
{{!}} Sets the ID of the parent product this belong an define the access right. Usually if it has been bought in a subscription or other package. For the movies bought directly, the same ID of the movies return.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
 
! SourceProductType
 
! SourceProductType
{{!}}  
+
{{!}} [[ProductType]]
{{!}}  
+
{{!}} Sets the type of the product has been bought to allow the access right.
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
Line 76: Line 76:
  
 
{
 
{
:        "ID": 1
+
:      "SourceProductType": 4,
 +
:      "SourceProductId": 105,
 +
:      "ProductTypeId": 6,
 +
:      "ProductId": 10060,
 +
:      "MovieAccessReason": 2,
 +
:      "RentalHoursLeft": 2147483647,
 +
:      "ExpirationDate": 253402297199,
 +
:      "PricingModel": {
 +
::        [[PricingModel]] object
 +
:      },
 +
:      "HaveMandatorySubscription": true,
 +
:      "MandatorySubscriptionId": 0,
 +
:      "MandatorySubscriptionMessage": "",
 +
:      "PurchaseStatus": 2
 
}
 
}
  

Latest revision as of 17:08, 3 June 2014


Members

Field Data Type Description
ExpirationDate long A timestamp that represent a time what the permission to access will be expired.
HaveMandatorySubscription bool Set if the user already has the Mandatory Subscription or not. The mandatory is a prerequisite to get access for the product.
MandatorySubscriptionId int Represents what is the Mandatory Subscription for the currently instance.
MandatorySubscriptionMessage String A Message defined on MIB Tools by each OB per Instance. It can be used to show some message to customer on client device.
MovieAccessReason MovieAccessReason Sets which kind of Access Right has the product.
PricingModel PricingModel type Sets the rules of pricing is applied for the product.
ProductId int Represents the ID of the product that this object is reference.
ProductTypeId ProductType Type of the product reference.
PurchaseStatus PurchaseStatus Represents the current status of the acquisition product.
RentalHoursLeft int
SourceProductId int Sets the ID of the parent product this belong an define the access right. Usually if it has been bought in a subscription or other package. For the movies bought directly, the same ID of the movies return.
SourceProductType ProductType Sets the type of the product has been bought to allow the access right.


Example

{

"SourceProductType": 4,
"SourceProductId": 105,
"ProductTypeId": 6,
"ProductId": 10060,
"MovieAccessReason": 2,
"RentalHoursLeft": 2147483647,
"ExpirationDate": 253402297199,
"PricingModel": {
PricingModel object
},
"HaveMandatorySubscription": true,
"MandatorySubscriptionId": 0,
"MandatorySubscriptionMessage": "",
"PurchaseStatus": 2

}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation Harley Cabral


See also