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...") |
|||
| 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. |
}} | }} | ||
| Line 38: | Line 38: | ||
|Exceptions= | |Exceptions= | ||
| + | * InvalidUserException | ||
| + | * InvalidServiceErrorException | ||
| + | |||
|Cache= | |Cache= | ||
Revision as of 19:52, 3 June 2014
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:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of xxx objects ]
}
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 |
