announcement /direct/announcement/describe

Represents announcements for a given site (including merged announcements) or all announcements for a user. Also includes Message Of The Day and public announcements. There are three optional URL parameters available: 'n' to set the total number of announcements returned, 'd' to set the number of days in the past to retrieve announcements for, and 'a' to set an ascending sort order of true or false. If the system is configured with the (default) 'Announcement Reorder' property, announcements will be additionally sorted by the message_order. If these parameters are not set, they are retrieved from the tool configuration, or the standard defaults of n=3, d=10, a=0 are used. For example /announcements/site/mercury.json?n=20&d=100&a=1 will retrieve up to 20 total announcements for up to 100 days ago with an ascending order.

/announcement/:ID: msg /direct/announcement/msg GET list Retrieve an announcement based on the path used by the announcements service internally, ie /announcement/msg/{siteId}/{channelId}/{announcementId}. Context is normally the site ID and the channelId is normally "main" unless there are multiple channels in a site. For example /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b motd /direct/announcement/motd GET list Retrieve only the MOTD announcements. site /direct/announcement/site GET list Retrieve the announcements for a site. If you are not logged in, you will only receive the public announcements for this site. message /direct/announcement/message GET list Retrieve an announcement based on the given siteId and messageId. eg /announcement/message/{siteId}/{msgId} user /direct/announcement/user GET list Retrieve the announcements for the current user. If you are not logged in, you will only receive the MOTD announcements. Announcements will be sorted by date and ignore the system's 'Announcement Reorder' configuration. xml json org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl$DecoratedAnnouncement bean announcementId java.lang.String true true attachments java.util.List true true body java.lang.String true true channel java.lang.String true true createdByDisplayName java.lang.String true true createdOn java.util.Date true true id java.lang.String true false siteId java.lang.String true true siteTitle java.lang.String true true title java.lang.String true true EntityProvider org.sakaiproject.entitybroker.entityprovider.EntityProvider ActionsExecutable org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable AutoRegisterEntityProvider org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider Describeable org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable Outputable org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable Resolvable org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable Sampleable org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable