Difference between revisions of "EnablePin"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Set to enable PIN of the type chosen. The PIN should have been disable or it doesn't exists. Is the last case, a new PIN will be created. The P...") |
|||
| Line 16: | Line 16: | ||
{{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 22: | Line 22: | ||
{{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:05, 17 February 2016
Description
Set to enable PIN of the type chosen. The PIN should have been disable or it doesn't exists. Is the last case, a new PIN will be created.
The PIN sent in request should be valid by the follow regular expression: "^[0-9]{4,4}$".
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
- InvalidCharPinException
- UserPinIsAlreadyEnabledException
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 |
