指定されたサイトに対するお知らせ (マージされたお知らせを含む) またはユーザに対するすべてのお知らせを表します．今日のメッセージおよび公開のお知らせも含みます．オプションの URL パラメータが 2 つあります: 'n' はお知らせの検索結果の合計を，'d' はお知らせを取得する日数です．パラメータの指定がない場合は，ツール設定の指定に従うか，デフォルト値である n=3, n=10 が使用されます．例えば，/announcements/site/mercury.json?n=20&d=100 は過去 100 日間について最大 20 件のお知らせを取得します．
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)
Sample Entity URLs (_id=':ID:') [may not be valid]:
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Custom Actions
msg :
list (GET) :
[/announcement/msg] (
xml) (
json)
お知らせサービスによって内部的に使用されるパスに基づいて，お知らせを取得します． 例えば /announcement/msg/{siteId}/{channelId}/{announcementId}. サイトに複数のチャネルがなければコンテキストは通常サイトIDでチャネルIDは通常"main"です．例えば /announcement/msg/21b1984d-af58-43da-8583-f4adee769aa2/main/5641323b-761a-4a4d-8761-688f4928141b
motd :
list (GET) :
[/announcement/motd] (
xml) (
json)
今日のお知らせのみを取得
site :
list (GET) :
[/announcement/site] (
xml) (
json)
サイトのお知らせを取得します．ログインしていない場合，このサイトの公開のお知らせのみ受信します．
message :
list (GET) :
[/announcement/message] (
xml) (
json)
与えられたサイトIDとメッセージIDに基づいて，お知らせを取得します．例えば /announcement/message/{siteId}/{msgId}
user :
list (GET) :
[/announcement/user] (
xml) (
json)
現在のユーザのお知らせを取得します．ログインしていない場合は，今日のお知らせのみを受信します．
Entity class : org.sakaiproject.announcement.entityprovider.AnnouncementEntityProviderImpl$DecoratedAnnouncement
Type :: bean
|
Name |
Type |
Status |
| 1) | announcementId | string | Read/Write |
| 2) | attachments | java.util.List | Read/Write |
| 3) | body | string | Read/Write |
| 4) | channel | string | Read/Write |
| 5) | createdByDisplayName | string | Read/Write |
| 6) | createdOn | java.util.Date | Read/Write |
| 7) | id | string | Read Only |
| 8) | siteId | string | Read/Write |
| 9) | siteTitle | string | Read/Write |
| 10) | title | string | Read/Write |
Data and Request Handling
Output formats : xml, json
Input formats : No formats allowed
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
|---|
| 1 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
| 2 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
| 3 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
| 4 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 5 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 6 | Resolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable | |
| 7 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$