/OpenForum/AddOn/Alert Sevice API Version 1.0.4


Get Actions

Action getAlerts

Parameters

NameDescription

Example Get Request

/OpenForum/AddOn/Alert?action=getAlerts /OpenForum/AddOn/Alert?action=getAlerts

Example Response

Example Error Response

Action addAlert

{{action.description}}

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=addAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=addAlert{{action.example.request}}

Example Response

Example Error Response

Action removeAlert

{{action.description}}

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=removeAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=removeAlert{{action.example.request}}

Example Response

Example Error Response

Action triggerAlert

{{action.description}}

Parameters

NameDescription
name (required=true){{parameter.description}}
reason (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=triggerAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=triggerAlert{{action.example.request}}

Example Response

Example Error Response

Action beatAlert

{{action.description}}

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=beatAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=beatAlert{{action.example.request}}

Example Response

Example Error Response

Action cancelAlert

{{action.description}}

Parameters

NameDescription
name (required=true){{parameter.description}}

Example Get Request

/OpenForum/AddOn/Alert?action=cancelAlert{{action.example.request}} /OpenForum/AddOn/Alert?action=cancelAlert{{action.example.request}}

Example Response

Example Error Response