editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Create a link to recover user's password. The link is sent to the user's e-mail. |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=in..."
{{Api_Method_Spec|
Description=Create a link to recover user's password. The link is sent to the user's e-mail.
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see [[DeviceType]] enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=E-mail from the user that wants to recover the password link.
}}
|Returns=
Returns a JSON object containing a boolean information about if is possible or not recover the password link.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #164;">true</span>
}
|Exceptions=
* [[InvalidUserException]]
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Create a link to recover user's password. The link is sent to the user's e-mail.
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see [[DeviceType]] enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=E-mail from the user that wants to recover the password link.
}}
|Returns=
Returns a JSON object containing a boolean information about if is possible or not recover the password link.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #164;">true</span>
}
|Exceptions=
* [[InvalidUserException]]
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
