Difference between revisions of "LoginUserHashCode"
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 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=LoginUserHashCode logs in the application using the has code sent in the registration process |
|Parameters= | |Parameters= | ||
| Line 13: | Line 13: | ||
|ParamType=string | |ParamType=string | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=Parameter used to preserve confidentiality | + | |ParamDescription=Parameter used to preserve confidentiality sent to the user e-mail. |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 19: | Line 19: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription=The device type code (see | + | |ParamDescription=The device type code (see [[DeviceType]] enumeration to know the list of device types allowed) |
}} | }} | ||
|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= | ||
| + | <span style="color: #a11;">TO BE COMPLETED</span> | ||
| − | |||
}} | }} | ||
Latest revision as of 13:32, 23 February 2016
Description
LoginUserHashCode logs in the application using the has code sent in the registration process
Parameters
- instanceId (int, required)
- The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
- hashCode (string, required)
- Parameter used to preserve confidentiality sent to the user e-mail.
- deviceType (int, required)
- The device type code (see DeviceType enumeration to know the list of device types allowed)
Returns
Exceptions
None
Caching
This method is not cached.
Known issues
None
Version history
TO BE COMPLETED
See also
TO BE COMPLETED
