Difference between revisions of "CreatePurchaseStb"

From Gvp-public
Jump to navigation Jump to search
 
(2 intermediate revisions by 2 users not shown)
Line 18: Line 18:
 
{{Api_Parameter|
 
{{Api_Parameter|
 
ParamName=productType
 
ParamName=productType
|ParamType=ProductType
+
|ParamType=[[ProductType]]
 
|ParamRequired=required
 
|ParamRequired=required
 
|ParamDescription=This use case deals with subscriptions.
 
|ParamDescription=This use case deals with subscriptions.
Line 28: Line 28:
 
|ParamDescription=[[PricingModel]] Id
 
|ParamDescription=[[PricingModel]] Id
 
}}
 
}}
 +
'''NEW IN 8.2!'''
 +
{{Api_Parameter|
 +
ParamName=TrackId
 +
|ParamType=String
 +
|ParamRequired=optional
 +
|ParamDescription=Recommendation Id
 +
}}
 +
{{Api_Parameter|
 +
ParamName=UxReference
 +
|ParamType=String
 +
|ParamRequired=optional
 +
|ParamDescription=Recommendation Reference
 +
}}
 +
  
 
|Returns=
 
|Returns=

Latest revision as of 13:08, 10 August 2020

Description

Create in a STB, a new purchase for product.

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user.
  • productId (int, required)
Product Id of the subscription to be purchased
This use case deals with subscriptions.
  • pricingModelId (int, required)
PricingModel Id

NEW IN 8.2!

  • TrackId (String, optional)
Recommendation Id
  • UxReference (String, optional)
Recommendation Reference


Returns

Returns a JSON object containing Purchase response.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content":

}


Exceptions

  • None


Caching

This method is not cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral
3.2 Enabled TVOD purchase of Series Pedro Caamaño


See also