Difference between revisions of "CreatePurchaseStb"

From Gvp-public
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...")
 
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|
Line 14: Line 20:
 
|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=Pricing Model Id
 
}}
 
}}
  

Revision as of 19:53, 18 September 2014

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)
Pricing Model Id


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


See also