editor
725
edits
Changes
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..."
{{Api_Method_Spec|
Description=
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=tokenRememberUser
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
|Returns=
Returns a JSON containing the [[Login]] object.
'''Example:'''
{
: [ <span style="color: #219;">[[Login]] object</span> ]
}
|Exceptions=
None
|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=
* [[RememberUser]]
}}
Description=
|Parameters=
{{Api_Parameter|
ParamName=deviceType
|ParamType=int
|ParamRequired=required
|ParamDescription=The device type code (see #DeviceTypeCodes enumeration to know the list of device types allowed)
}}
{{Api_Parameter|
ParamName=instanceId
|ParamType=int
|ParamRequired=required
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
}}
{{Api_Parameter|
ParamName=tokenRememberUser
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
|Returns=
Returns a JSON containing the [[Login]] object.
'''Example:'''
{
: [ <span style="color: #219;">[[Login]] object</span> ]
}
|Exceptions=
None
|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=
* [[RememberUser]]
}}
