Difference between revisions of "LoginUserCode"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=instanceId |ParamType=int |ParamRequired=required |ParamDescription=The id of the instance (OB) for th...") |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=This methos does the log-in in the application using the user code. |
|Parameters= | |Parameters= | ||
| Line 23: | Line 23: | ||
|Returns= | |Returns= | ||
| + | Returns a JSON containing the Login object. | ||
| + | Example: | ||
| + | |||
| + | { | ||
| + | : [[Login]] Object | ||
| + | } | ||
| + | |||
|Exceptions= | |Exceptions= | ||
| Line 32: | Line 39: | ||
|KnownIssues= | |KnownIssues= | ||
None | None | ||
| + | |||
|VersionHistory= | |VersionHistory= | ||
| − | + | <span style="color: #a11;">TO BE COMPLETED</span> | |
|SeeAlso= | |SeeAlso= | ||
| + | * [[LoginUserHashCode]] method | ||
| + | * [[LoginUserPassword]] method | ||
| + | * [[LoginUserPasswordTEF]] method | ||
| + | * [[LoginApplicationToken]] method | ||
}} | }} | ||
Latest revision as of 13:31, 23 February 2016
Description
This methos does the log-in in the application using the user code.
Parameters
- instanceId (int, required)
- The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
- userCode (string, required)
- deviceType (int, required)
- The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
Returns
Returns a JSON containing the Login object. Example:
{
- Login Object
}
Exceptions
None
Caching
This method is not cached.
Known issues
None
Version history
TO BE COMPLETED
See also
- LoginUserHashCode method
- LoginUserPassword method
- LoginUserPasswordTEF method
- LoginApplicationToken method
