指定されたサイトの名簿を表しています．
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)
Custom Actions
site :
list (GET) :
[/roster/site] (
xml) (
json)
サイトに対するメンバリストを取得します．リクエストURLパタン: /direct/roster/site/{siteId}.{format} リクエストURLにofficialImages=true を設定するとユーザの公式なイメージの取得を選択できます．
group :
list (GET) :
[/roster/group] (
xml) (
json)
グループに対するメンバリストを取得します．リクエストURLパタン: /direct/roster/group/{siteId}/{groupId/groupName}.{format} リクエストURLにofficialImages=true を設定するとユーザの公式なイメージの取得を選択できます．
URL Redirects
1) /roster/user/{id} ==>
calculated destination
ユーザプロファルを /profile/ entity provider から取得します．
Entity class : org.sakaiproject.profile2.tool.entityprovider.RosterEntityProvider$RosterItem
Type :: bean
|
Name |
Type |
Status |
| 1) | displayName | string | Read/Write |
| 2) | imageUrl | 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 | Redirectable | org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable | |
| 7 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$