Difference between revisions of "Template:Api Method Spec"
Jump to navigation
Jump to search
(Created page with "__NOTOC__ == Description == {{{Description}}} == Parameters == {{{Parameters}}} == Returns == {{{Returns}}} == Exceptions == {{{Exceptions}}} == Caching == {{{Ca...") |
|||
| Line 2: | Line 2: | ||
== Description == | == Description == | ||
| − | {{{Description}}} | + | {{{Description}}} |
| + | |||
| + | The following parameters are always overwritten by GVP | ||
| + | |||
| + | * USERID -> (From token) | ||
| + | * DEVICEID -> (From token, deviceID in case it is a loginTrustedDevice, User IP if loginUserPAssword) | ||
| + | * DEVICETYPEID (From token) | ||
| + | * IPADDRESS (From request heades) | ||
| + | * INSTANCEID -> (From token) | ||
| + | * LANGUAGEID -> (From token) | ||
| + | * SESSIONID -> (From token: currently empty because some device couldnt support it) | ||
| + | * CONTEXT -> (From token: always true) | ||
| + | |||
| + | |||
| + | Avoid also using any parameter Starting By MIB* (It returns an error in the method) | ||
| + | |||
| + | examples | ||
| + | * MIBAPPLICATIONAME | ||
| + | * MIBTIMESTAMP | ||
| + | * MIBEVENTNAME | ||
== Parameters == | == Parameters == | ||
Revision as of 15:18, 16 November 2016
Description
{{{Description}}}
The following parameters are always overwritten by GVP
- USERID -> (From token)
- DEVICEID -> (From token, deviceID in case it is a loginTrustedDevice, User IP if loginUserPAssword)
- DEVICETYPEID (From token)
- IPADDRESS (From request heades)
- INSTANCEID -> (From token)
- LANGUAGEID -> (From token)
- SESSIONID -> (From token: currently empty because some device couldnt support it)
- CONTEXT -> (From token: always true)
Avoid also using any parameter Starting By MIB* (It returns an error in the method)
examples
- MIBAPPLICATIONAME
- MIBTIMESTAMP
- MIBEVENTNAME
Parameters
{{{Parameters}}}
Returns
{{{Returns}}}
Exceptions
{{{Exceptions}}}
Caching
{{{Cache}}}
Known issues
{{{KnownIssues}}}
Version history
{{{VersionHistory}}}
See also
{{{SeeAlso}}}
