Common Uses
Quick publish
To start using publishing APIs for simple use cases, use the following table as a quick reference.
Process | API call | Notes |
|---|---|---|
Show a list of alert templates defined within BlackBerry AtHoc . | GET-SCENARIOS | You can fetch only quick publish alert template or all alert templates. |
Choose an alert template to publish; show alert template details. | GET-SCENARIO | — |
Publish a given alert template as-is or with edits. | INFOCASTING | type="ALERT | ALERTSCENARIO" action ="PUBLISH" |
Put a draft alert into standby mode so that it can be reviewed or held until a later time. | INFOCASTING | type=”ALERT” action=”STANDBY” |
Check Alert publish status and fetch detailed reporting back. | INFOCASTING | type="ALERT-TRACKING-DETAILS" id="1234567" |
Alert will be ended automatically at end time (defined during publishing of an alert) but you can end it before that time by making an explicit call mentioned here. | INFOCASTING | type="ALERT" AlertData action ="END" |
Retrieve all Live Alerts in the organization along with tracking summary. | INFOCASTING | Type=”ALERT-LIST” |
Advanced publishing
The following table lists APIs around user groups and hierarchies that may be required for advanced publishing. For example, if there are no alert templates defined within
BlackBerry AtHoc
for these advanced targeting settings, you can publish to any of these groups/hierarchy nodes using these APIs.Process | API call |
|---|---|
Retrieve Organizational Hierarchy structure and use the lineage-based node names for targeting within publishing API within Infocasting. | GET-HIERARCHY |
Retrieve list of all distribution lists within given system and target any of the lists by ID or common name. | GET-DISTRIBUTION-LISTS |
Retrieve list of all enabled devices within this system. | GET-DEVICES |
Retrieve list of all alert folders to use for filtering the list of alert templates and alerts. | GET-ALL-CHANNELS |