Purpose
The topics API is used to ____________.
UI Reference: The API is called when the ___ button is clicked on the ___ page.
URI : webapp-api-findanswer?api=topics
Access Rights Required:
Request
Request Parameters
Name |
Type |
Description |
|---|---|---|
__TZO__ |
String |
Shows Time Zone Offset. |
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
Request Payload Example
{ "__TZO__": "-08:00", "_pageAction": "FindAnswerTopics" } |
Response
Response Parameters
Name |
Type |
Description |
|---|---|---|
topics |
Array |
An array of strings. Returns the details for a topic in the array. |
topics[].id |
String |
ID of the topic. |
topics[].name |
String |
Name of the topic. |
topics[].count |
Integer |
The number of articles in the topic (viewable by the user). |
topics[].countRecurse |
Integer |
The number of articles for the topic and its children (viewable by the user). |
topics[].parentID |
String |
ID of the parent topic (Topics may be hierarchical) |
topics[].visibility |
String |
Indicates whether the topic is public, private or deleted. |
topics[].prefix |
String |
|
topics[].option |
String |
An alternative topic name for display in menus. |
topics[].segment |
String |
The segment the associated with the topic. |
topics[].isAvailable |
Boolean |
|
topics[].segmentID |
String |
ID of the segment in which the topic is created. |
Response Example
{ "topics": [ { "id": "7", "name": "Technical Support", "count": 6, "countRecurse": 6, "parentID": "1", "visibility": "public", "prefix": ". . ", "option": ". . Technical Support", "segmentName": "e-shop", "isAvailable": false, "segmentID": "2" } ] } |
