Difference between revisions of "GetDefaultOBPinNumber"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get the default value of PIN (for each type of pinType) in the instance. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |Para...") |
|||
| Line 31: | Line 31: | ||
|Exceptions= | |Exceptions= | ||
| − | * [[]] | + | * [[InvalidPinTypeException]] |
| + | * [[UserPinNotRegisteredException]] | ||
|Cache= | |Cache= | ||
Revision as of 18:50, 12 August 2014
Description
Get the default value of PIN (for each type of pinType) in the instance.
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.
Returns
Returns a JSON object containing an object of OBPinDefault.
Example:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- { Object of OBPinDefault }
}
Exceptions
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 |
