Chapter 88: Controller: /siteworx/mysql/user Up Part III: SiteWorx API Spec Chapter 90: Controller: /siteworx/overview 

89 Controller: /siteworx/notice

Required Permissions "LOGIN"
Action: dismissBanner
Added in version 4.7.0-339
Description Dismisses a banner notice.
Input Parameters
Name Type Notes Required?
delivery_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: fail
Added in version n/a
Description Magic function - test for failure mechanism.
Action: ignoreUntil
Added in version 4.7.0-339
Description Ignore a notice until a certain time.
Input Parameters
Name Type Notes Required?
delivery_id struct (integer) Yes
ignore_until integer Example Values
0, 1, 2, 3, 4, 5
Yes
Action: listBannerNotices
Added in version 4.7.0-339
Description Lists current banner notices.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’delivery_id’ => ’79808’,
’code’ => ’’,
’priority’ => ’negative’,
’node_id’ => ’’,
’subject’ => ’Test notice’,
’body’ => ’Test Notice!’,
’date_created’ => ’1531337395’,
),
),
)
Action: removeUnsubscription
Added in version 4.7.0-339
Description Removes an unsubscription block for the current user.
Input Parameters
Name Type Notes Required?
code integer Yes
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
Name Type Notes Required?
controller string Example Values
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout
Yes
Action: unsubscribe
Added in version 4.7.0-339
Description Unsubscribes the current user from a problem code.
Input Parameters
Name Type Notes Required?
code string Yes
Action: unsubscribeAll
Added in version 6.1.9-1465
Description Unsubscribe from all notices.
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 88: Controller: /siteworx/mysql/user Up Part III: SiteWorx API Spec Chapter 90: Controller: /siteworx/overview 

(C) 2018 by InterWorx LLC