RecoverPassword - Revision history

Rcalvo at 20:10, 3 June 2014

2014-06-03T20:10:45Z

Rcalvo at 20:00, 3 June 2014

2014-06-03T20:00:50Z

Rcalvo at 20:00, 3 June 2014

2014-06-03T20:00:18Z

Rcalvo at 19:56, 3 June 2014

2014-06-03T19:56:50Z

Rcalvo at 19:55, 3 June 2014

2014-06-03T19:55:10Z

Rcalvo at 19:52, 3 June 2014

2014-06-03T19:52:42Z

Rcalvo: Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=int |ParamRequired=required |ParamDescription=A valid token for identifying the AP..."

2014-06-03T19:21:45Z

Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=int |ParamRequired=required |ParamDescription=A valid token for identifying the AP..."

New page

{{Api_Method_Spec|
Description=

|Parameters=

{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=userName
|ParamType=String
|ParamRequired=required
|ParamDescription=
}}

|Returns=
Returns a JSON object containing an array of xxx.

'''Example:'''

{
: "Offset": 0,
: "Limit": 100,
: "Count": 6,
: "List":
:: [ Array of xxx objects ]
}

|Exceptions=

|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=
}}

@@ Line 37: / Line 37: @@
 |Exceptions=
-* InvalidUserException
+* [[InvalidUserException]]
-* InvalidServiceErrorException
+* [[InvalidServiceErrorException]]

@@ Line 33: / Line 33: @@
 :    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">3</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>
+}

@@ Line 32: / Line 32: @@
 :    <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;">"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: #219;">Boolean status</span> ]
+::     [ <span style="color: #219;">(true/false) - Boolean status</span> ]
+}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=
+Description=Generate a new password and send it to logged user in this time by the token.
 |Parameters=
@@ Line 25: / Line 25: @@
 |Returns=
-Returns a JSON object containing an array of xxx.
+Returns a JSON object containing a information about if is possible or not recover the password.
 '''Example:'''
@@ Line 34: / Line 34: @@
 :    <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;">"Content"</span>:
-::     [ <span style="color: #219;">[[Boolean]] status</span> ]
+::     [ <span style="color: #219;">Boolean status</span> ]
+}

@@ Line 30: / Line 30: @@
+{
-:    <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
+:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">36</span>,
-:    <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
+:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">3</span>,
-:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</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;">"List"</span>:
+:    <span style="color: #a11;">"Content"</span>:
-::     [ <span style="color: #219;">Array of xxx objects</span> ]
+::     [ <span style="color: #219;">[[Boolean]] status</span> ]
+}

@@ Line 8: / Line 8: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
+|ParamDescription=The device type code (see [[DeviceType]] enumeration to know the list of device types allowed)
 }}
 {{Api_Parameter|
@@ Line 14: / Line 14: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
 }}
 {{Api_Parameter|
@@ Line 20: / Line 20: @@
 |ParamType=String
 |ParamRequired=required
-|ParamDescription=
+|ParamDescription=E-mail from the user that wants to recover the password.
 }}
@@ Line 38: / Line 38: @@
 |Exceptions=
 |Cache=