RecoverPassword
Jump to navigation
Jump to search
Description
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 an array of xxx.
Example:
{
- "StatusCode": 36,
- "Severity": 3,
- "StatusMessage": "E-mail inválido. Por favor, verifique seu e-mail cadastrado e tente novamente.",
- "Content":
- [ Boolean status ]
}
Exceptions
- InvalidUserException
- InvalidServiceErrorException
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 |