Difference between revisions of "GetContentSelection"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description= This method returns content from a determinated Id.
  
 
|Parameters=
 
|Parameters=
Line 11: Line 11:
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
ParamName=instanceId
+
ParamName=selectionId
 
|ParamType=int
 
|ParamType=int
 
|ParamRequired=required
 
|ParamRequired=required
|ParamDescription=The number (ID) of one instance that represent an OB registered in this environment. The same of the user has been registered.
+
|ParamDescription=
 
}}
 
}}
  
|Returns=
+
|Returns=Returns a JSON object containing an array of content.
  
 +
'''Example:'''
 +
 +
{
 +
:  "StatusCode": 0,
 +
:  "Severity": 1,
 +
:  "StatusMessage": "OK",
 +
:  "Content": [
 +
:    {
 +
:      "Type": 0,
 +
:      "Field": 0,
 +
:      "Value": "1"
 +
:    }
 +
:    { Rest of contents }
 +
:  ]
 +
}
  
 
|Exceptions=
 
|Exceptions=
 
+
<span style="color: #a11;">TO BE COMPLETED</span>
  
 
|Cache=
 
|Cache=
Line 30: Line 45:
  
 
|VersionHistory=
 
|VersionHistory=
 +
<span style="color: #a11;">TO BE COMPLETED</span>
 +
 +
|SeeAlso=
  
  
|SeeAlso=
 
 
}}
 
}}

Latest revision as of 08:24, 22 September 2015

Description

This method returns content from a determinated Id.

Parameters

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • selectionId (int, required)


Returns

Returns a JSON object containing an array of content.

Example:

{

"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": [
{
"Type": 0,
"Field": 0,
"Value": "1"
}
{ Rest of contents }
]

}


Exceptions

TO BE COMPLETED


Caching

This method is cached as default.


Known issues

None


Version history

TO BE COMPLETED


See also