SDK payload types
This section lists available SDK payload types.
API | Payload type | Use |
|---|---|---|
User Synchronization | USER-SYNC | User synchronization with extended attributes, and static lists. |
User synchronization | USER-SYNC-NEW | User synchronization. |
User Details | GET-USER | |
Feed API | INFOCASTING | |
Alert Tracking | ALERT-TRACKING-SUMMARY | |
Alert Tracking | ALERT-TRACKING-DETAILS | |
Alert Tracking | ALERT-LIST | |
Get content | GET-DISTRIBUTION-LISTS | |
Get content | GET-SCENARIOS | |
Get content | GET-SCENARIO | |
Get content | GET-HIERARCHY | |
Get content | GET-DEVICES | |
Get Provider Details | GET-PROVIDER | |
Diagnostic Log | DIAGNOSTIC-LOG | |
Set Content | HIERARCHY-SYNC | Set the organizational, distribution list, or location hierarchy. |
Get content | GET-ALL-CHANNELS |
Deprecated Payload Types
API | Payload type | Use |
|---|---|---|
Alert Tracking | ALERT-TRACKING-DEVICE-SUMMARY | Get Alert Tracking summary by device report. |
C2 Alerting | GET-USER-PERSONAL-RULES | Retrieve all rules for a user.Deprecated as of V6.1.8.84. |
C2 Alerting | DELETE-PERSONAL-RULE | Delete a rule.Deprecated as of V6.1.8.84. |
C2 Alerting | GET-ALL-PERSONAL-RULES | Retrieve all rules for all users.Deprecated as of V6.1.8.84. |
C2 Alerting | GET-PERSONAL-RULE | Retrieve an existing rule.Deprecated as of V6.1.8.84. |
C2 Alerting | CREATE-PERSONAL-RULE | Create a rule for receiving alerts.Deprecated as of V6.1.8.84. |
C2 Alerting | UPDATE-PERSONAL-RULE | Update an existing rule.Deprecated as of V6.1.8.84. |
Delivery | SEND-PENDING-MESSAGES | Send pending user messages.Deprecated as of V6.1.8.84. |
Delivery subscription | GET-SERVICE-DELIVERY-PREFERENCES | Get user delivery preferences for a feed or alert folder service.Deprecated as of V6.1.8. |
Delivery subscription | SET-SERVICE-DELIVERY-PREFERENCES | Update user delivery preferences for a feed or alert folder service.Deprecated as of V6.1.8. |
Delivery subscription | GET-DELIVERY-PREFERENCES | Get user delivery preferences for a all subscribed feed and alert folder services.Deprecated as of V6.1.8. |
Get content | CLICK-TRACK | Indicate that a user clicked an alert message or a feed item.Deprecated as of V6.1.8.84. |
Get content | GET-CONTENT | Get content of all or some dynamic services (alert folders) for a user.Deprecated as of V6.1.8.84. |
Get content | GET-ALL-CHANNELS | Get a collection of all or some dynamic services (alert folders) for all users.Deprecated as of V6.1.8.84. Now the GET-ALL-CHANNELS returns list of alert folders for an organization. |
Group-sets synchronization | GROUP-SETS | Synchronize group-sets.Deprecated as of V6.1.8. |
Infocasting | PUBLISH (System Alert only) | System Alert is now deprecated starting with 6.1.8.87 and has been replaced by Enterprise Alert. |
Personal services | GET-ADDRESS-FOR-NEW-SERVICE | Get available user device addresses for new personal feed or alert folder.Deprecated as of V6.1.8.84. |
Personal services | UPDATE-PERSONAL-SERVICE | Update parameters of a personal feed or alert folder.Deprecated as of V6.1.8. |
Personal services | CREATE-PERSONAL-SERVICE | Create a personal feed or alert folder.Deprecated as of V6.1.8. |
Personal services | DELETE-PERSONAL-SERVICE | Delete a personal service.Deprecated as of V6.1.8. |
Personal services | GET-PERSONAL-SERVICE | Get parameters of a personal feed or alert folder.Deprecated as of V6.1.8. |
User addresses | USER-DEVICE-ADDRESS-ACTION | Create, update and delete addresses for delivery devices. Deprecated as of 6.1.8.85 R2 CP1. Use the device element in USER-SYNC. |
User Channel Subscription | GET-USER-CHANNEL-SUBSCRIPTION | Retrieve a list of user subscribed folders. |
User Group synchronization | USER-GROUP-SYNC | Synchronize a user’s groups. Deprecated as of V6.1.8. |
User groups | GET-USER-GROUPS | Get user groups.Deprecated as of V6.1.8. |
User groups | SET-USER-GROUPS | Set user groups.Deprecated as of V6.1.8. |
User Profile Synchronization | USER-SYNC-PROFILE | Synchronize a user’s desktop software.Deprecated as of V6.1.8. |
User subscription | SET-USER-BUTTON-SUBSCRIPTION | Set user button subscription.Deprecated as of V6.1.8.84. |
User subscription | GET-USER-BUTTONS | Get user buttons.Deprecated as of V6.1.8.84. |
User subscription | GET-USER-BUTTON-SUBSCRIPTION | Get user button subscription options.Deprecated as of V6.1.8.84. |
Set Content | SET-USER-DEVICE-ADDRESS | Deprecated as of V6.1.8.89 |
User subscription | SET-USER-CHANNEL-SUBSCRIPTION | User subscriptionDeprecated as of V6.1.8.89 |
User subscription | GET-USER-CHANNEL-SUBSCRIPTION | User subscriptionDeprecated as of V6.1.8.89 |