Purpose
The mysubscriptions API is used to show the subscriptions to articles.
UI Reference: The API is called when the ___ button is clicked on the ___ page.
URI: webapp-api-findanswer?api=mysubscriptions
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": "FindAnswerMySubscriptions" } |
Response
Response Parameters
Name |
Type |
Description |
|---|---|---|
lists |
Array |
Shows the list of all subscriptions to a contact. |
lists[].id |
String |
|
lists[].name |
String |
Shows name of the subscription |
lists[].descriptions |
String |
Shows the description of the subscription. |
lists[].isOnList |
Boolean |
|
campaigns |
Array |
|
campaigns[].id |
String |
|
campaigns[].name |
String |
|
campaigns[].descriptions |
String |
|
campaigns[].isOnList |
Boolean |
|
articles |
Array |
Response Example
{ "lists": [ { "id": "6", "name": "Online Specials", "description": "Receive notices about online specials.", "isOnList": false } ], "campaigns": [ { "id": "campaign-1", "name": "Photography tips and trick", "description": "Ongoing tips for getting the most out of your new camera.", "isOnList": false } ], "articles": [] } |
