Difference between revisions of "LoginUserCode"

From Gvp-public
Jump to navigation Jump to search
 
Line 23: Line 23:
  
 
|Returns=
 
|Returns=
<span style="color: #a11;">TO BE COMPLETED</span>
+
Returns a JSON containing the Login object.
 +
Example:
 +
 
 +
{
 +
:    [[Login]] Object
 +
}
 +
 
  
 
|Exceptions=
 
|Exceptions=

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