Difference between revisions of "DisablePin"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Set to disable the PIN of the type chosen. The PIN should have been enable and has been activated before. The user should be logged to use this...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 14: | Line 14: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=pinType | ParamName=pinType | ||
| − | |ParamType= UserPinType | + | |ParamType= [[UserPinType]] |
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=Define the type of pin. | |ParamDescription=Define the type of pin. | ||
| Line 20: | Line 20: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=pin | ParamName=pin | ||
| − | |ParamType= | + | |ParamType=string |
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=The value of pin | |ParamDescription=The value of pin | ||
Latest revision as of 09:04, 17 February 2016
Description
Set to disable the PIN of the type chosen. The PIN should have been enable and has been activated before.
The user should be logged to use this method.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- pinType (UserPinType, required)
- Define the type of pin.
- pin (string, required)
- The value of pin
Returns
Returns a JSON object containing true for successful.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content": true
}
Exceptions
- AuthenticationRequiredException
- InvalidPinTypeException
- UserPinIsAlreadyDisabledException
- UserParentalPinValueNoMatchException
- UserPurchasePinValueNoMatchException
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 |
