Difference between revisions of "CreatePurchaseStb"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Create in a STB, a new purchase for product. |Parameters= {{Api_Parameter| ParamName=productId |ParamType=int |ParamRequired=required |ParamDe...") |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
|Parameters= | |Parameters= | ||
| + | {{Api_Parameter| | ||
| + | ParamName=token | ||
| + | |ParamType=String | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription=A valid token for identifying the API session context and logged user. | ||
| + | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=productId | ParamName=productId | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Product Id of the subscription to be purchased |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=productType | ParamName=productType | ||
| − | |ParamType=ProductType | + | |ParamType=[[ProductType]] |
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=This use case deals with subscriptions. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 20: | Line 26: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |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= | ||
| Line 54: | Line 74: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Enabled TVOD purchase of Series | ||
| + | {{!}} Pedro Caamaño | ||
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
}} | }} | ||
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
- productType (ProductType, required)
- 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 |
