Difference between revisions of "LoginRememberUser"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=deviceType |ParamType=int |ParamRequired=required |ParamDescription=The device type code (see #DeviceTyp...") |
|||
| Line 20: | Line 20: | ||
|ParamType=String | |ParamType=String | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=A valid token for identifying the API session context. | + | |ParamDescription=A valid token for identifying the API session context. This token is generated by the [[RememberUser]]. |
}} | }} | ||
| Line 29: | Line 29: | ||
{ | { | ||
| − | : | + | : [[Login]] object |
} | } | ||
|Exceptions= | |Exceptions= | ||
| − | + | * [[InvalidUserException]] | |
| + | * [[InvalidTokenException]] | ||
|Cache= | |Cache= | ||
Revision as of 19:41, 4 June 2014
Description
Parameters
- deviceType (int, required)
- The device type code (see #DeviceTypeCodes 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.
- tokenRememberUser (String, required)
- A valid token for identifying the API session context. This token is generated by the RememberUser.
Returns
Returns a JSON containing the Login object.
Example:
{
- Login object
}
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 |
