Difference between revisions of "RecoverPassword"

From Gvp-public
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 32: Line 32:
 
:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">36</span>,
 
:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">36</span>,
 
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">3</span>,
 
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">3</span>,
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"E-mail inválido. Por favor, verifique seu e-mail cadastrado e tente novamente."</span>,
+
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"Ok"</span>,
:    <span style="color: #a11;">"Content"</span>:  
+
:    <span style="color: #a11;">"Content"</span>: <span style="color: #164;">true</span>
::    [ <span style="color: #219;">Boolean status</span> ]
 
 
}
 
}
  
 
|Exceptions=
 
|Exceptions=
* InvalidUserException
+
* [[InvalidUserException]]
* InvalidServiceErrorException
+
* [[InvalidServiceErrorException]]
  
  

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


See also