Difference between revisions of "RecoverPassword"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=int |ParamRequired=required |ParamDescription=A valid token for identifying the AP...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=Generate a new password and send it to logged user in this time by the token. |
|Parameters= | |Parameters= | ||
| Line 8: | Line 8: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=The device type code (see [[DeviceType]] enumeration to know the list of device types allowed) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 14: | Line 14: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 20: | Line 20: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=E-mail from the user that wants to recover the password. |
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing a information about if is possible or not recover the password. |
'''Example:''' | '''Example:''' | ||
{ | { | ||
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">36</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">3</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"Ok"</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Content"</span>: <span style="color: #164;">true</span> |
| − | |||
} | } | ||
|Exceptions= | |Exceptions= | ||
| + | * [[InvalidUserException]] | ||
| + | * [[InvalidServiceErrorException]] | ||
| + | |||
|Cache= | |Cache= | ||
Latest revision as of 20:10, 3 June 2014
Description
Generate a new password and send it to logged user in this time by the token.
Parameters
- deviceType (int, required)
- The device type code (see DeviceType enumeration to know the list of device types allowed)
- instanceId (int, required)
- The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
- userName (String, required)
- E-mail from the user that wants to recover the password.
Returns
Returns a JSON object containing a information about if is possible or not recover the password.
Example:
{
- "StatusCode": 36,
- "Severity": 3,
- "StatusMessage": "Ok",
- "Content": true
}
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 |
