Difference between revisions of "GetInstanceInterests"
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 AP...") |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=For a determinated instance this method gets information about its interests. Token parameter is needed. |
|Parameters= | |Parameters= | ||
| Line 10: | Line 10: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=instanceId |
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object with the list of | + | Returns a JSON object with the list of objects. |
'''Example:''' | '''Example:''' | ||
| − | |||
{ | { | ||
"StatusCode": 0, | "StatusCode": 0, | ||
"Severity": 1, | "Severity": 1, | ||
"StatusMessage": "OK", | "StatusMessage": "OK", | ||
| − | "Content": { | + | "Content": [ |
| − | + | { | |
| − | + | "ID": 12, | |
| − | + | "Description": "Int_3_0_10 d", | |
| − | + | "Name": "Int_3_0_10", | |
| − | + | "ResizableImages": [ | |
| + | { | ||
| + | "ID": 0, | ||
| + | "Url": "", | ||
| + | "Width": 0, | ||
| + | "Height": 0, | ||
| + | "Type": 0, | ||
| + | "Ext": "" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | { ... } | ||
} | } | ||
| Line 68: | Line 48: | ||
|Cache= | |Cache= | ||
| − | + | This method is not cached. | |
|KnownIssues= | |KnownIssues= | ||
| Line 77: | Line 57: | ||
|SeeAlso= | |SeeAlso= | ||
| − | + | * [[UNIAPI_Specification#Interest_Service| InterestService]] methods | |
}} | }} | ||
Latest revision as of 12:04, 22 September 2015
Description
For a determinated instance this method gets information about its interests. Token parameter is needed.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- instanceId (int, required)
- The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
Returns
Returns a JSON object with the list of objects.
Example: {
"StatusCode": 0,
"Severity": 1,
"StatusMessage": "OK",
"Content": [
{
"ID": 12,
"Description": "Int_3_0_10 d",
"Name": "Int_3_0_10",
"ResizableImages": [
{
"ID": 0,
"Url": "",
"Width": 0,
"Height": 0,
"Type": 0,
"Ext": ""
}
]
}
{ ... }
}
Exceptions
TO BE COMPLETED
Caching
This method is not cached.
Known issues
None
Version history
TO BE COMPLETED
See also
- InterestService methods
