Difference between revisions of "CancelProduct"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Cancel product purchase by product Id Should be used by logged user. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRe...") |
|||
| Line 42: | Line 42: | ||
: <span style="color: #a11;">"Content"</span>: <span style="color: #219;">""</span> | : <span style="color: #a11;">"Content"</span>: <span style="color: #219;">""</span> | ||
} | } | ||
| + | |||
| + | '''Example2''' | ||
| + | { | ||
| + | "StatusCode": 0, | ||
| + | "Severity": 1, | ||
| + | "StatusMessage": "OK", | ||
| + | "Content": { | ||
| + | "ID": 1107, | ||
| + | "Type": 4, | ||
| + | "Favorite": false, | ||
| + | "Stars": 0, | ||
| + | "CanWatch": { | ||
| + | "SourceProductType": 4, | ||
| + | "SourceProductId": 1107, | ||
| + | "ProductTypeId": 4, | ||
| + | "ProductId": 1107, | ||
| + | "MovieAccessReason": 2, | ||
| + | "RentalHoursLeft": 95, | ||
| + | "ExpirationDate": 1516551179, | ||
| + | "PricingModel": { | ||
| + | "ID": 676, | ||
| + | "Title": "Recurrent 4 days", | ||
| + | "Chargingclass": "", | ||
| + | "UserType": 1, | ||
| + | "Price": 10, | ||
| + | "RecurrenceType": 9, | ||
| + | "DevicesType": [], | ||
| + | "Isrecurring": true, | ||
| + | "GrantAllDevices": true, | ||
| + | "Quality": 2, | ||
| + | "RecurrenceDays": 0 | ||
| + | }, | ||
| + | "HaveMandatorySubscription": true, | ||
| + | "MandatorySubscriptionId": 0, | ||
| + | "MandatorySubscriptionMessage": "", | ||
| + | "PurchaseStatus": 7, | ||
| + | "StartDate": 0 | ||
| + | }, | ||
| + | "CanAcquire": true, | ||
| + | "HaveVoDAccess": true, | ||
| + | "AvailableForThisDevice": true, | ||
| + | "AvailableForThisDeviceInHD": true, | ||
| + | "AvailableForThisDeviceInSD": true, | ||
| + | "BestMediaToPlay": 0 | ||
| + | } | ||
| + | } | ||
| + | |||
|Exceptions= | |Exceptions= | ||
Latest revision as of 16:43, 17 January 2018
Description
Cancel product purchase by product Id
Should be used by logged user.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- productId (int, required)
- A product id for the product that wants to cancel.
- productTypeId (productType, required)
- Type id of the product that wants to cancel the purchase.
- pin (String, required)
- PurchasePin to authenticate the purchase.
Returns
Returns a JSON object containing a user product information.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": ""
}
Example2
{
"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": {
"ID": 1107,
"Type": 4,
"Favorite": false,
"Stars": 0,
"CanWatch": {
"SourceProductType": 4,
"SourceProductId": 1107,
"ProductTypeId": 4,
"ProductId": 1107,
"MovieAccessReason": 2,
"RentalHoursLeft": 95,
"ExpirationDate": 1516551179,
"PricingModel": {
"ID": 676,
"Title": "Recurrent 4 days",
"Chargingclass": "",
"UserType": 1,
"Price": 10,
"RecurrenceType": 9,
"DevicesType": [],
"Isrecurring": true,
"GrantAllDevices": true,
"Quality": 2,
"RecurrenceDays": 0
},
"HaveMandatorySubscription": true,
"MandatorySubscriptionId": 0,
"MandatorySubscriptionMessage": "",
"PurchaseStatus": 7,
"StartDate": 0
},
"CanAcquire": true,
"HaveVoDAccess": true,
"AvailableForThisDevice": true,
"AvailableForThisDeviceInHD": true,
"AvailableForThisDeviceInSD": true,
"BestMediaToPlay": 0
}
}
Exceptions
- AuthenticationRequiredException
- UserPurchasePinValueNoMatchException
- UserHasNoRightsToThisProductException
- PurchaseNotFoundException
- NonRenewableUserRightException
- PurchaseAlreadyCancelledException
- PurchaseAlreadyInCancellingException
- PurchaseAlreadyInPendingOBCancellationException
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 |
