userPrefs (xml)

ユーザ属性値
RESTful URLs: http://microformats.org/wiki/rest/urls
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]:

Entity Collection URL: GET /userPrefs (xml) (json) (html)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Create Entity URL: POST /userPrefs
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /userPrefs/:ID: (xml) (json) (html)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Update Entity URL: PUT /userPrefs/:ID:
Response Code Details: 204; 400 if inputs invalid
Delete Entity URL: DELETE /userPrefs/:ID:
Response Code Details: 204; 404 if not found

Custom Actions

updateKey : edit (PUT) : [/userPrefs/:ID:/updateKey]
キープロパティ値を所得します．リクエストURLパタン： /direct/userPrefs/updateKey/{user_id}/{key_name}/{name=val&name1=val1...}
saveDivState : edit (PUT) : [/userPrefs/:ID:/saveDivState]
現在のユーザプリファレンスとしてキーバリューペアを保存します．リクエストURLパタン： /direct/userPrefs/saveDivState/{key_name}/{state_value}
key : list (GET) : [/userPrefs/key] (xml) (json) (html)
ユーザIDおよびプロパティキー名を与えるユーザプリファレンス属性設定を取得します．リクエストURLパタン： /direct/userPrefs/key/{user_id}/{key_name}.{format}

Entity class : org.sakaiproject.user.impl.BasePreferencesService$BasePreferences

Type :: bean
Name Type Status
1) activeEditbooleanRead Only
2) idstringRead Only
3) keysjava.util.CollectionRead Only
4) propertiesorg.sakaiproject.entity.api.ResourcePropertiesRead Only
5) propertiesEditorg.sakaiproject.entity.api.ResourcePropertiesEditRead Only
6) referencestringRead Only
7) urlstringRead Only

Data and Request Handling

Output formats : xml, json, html
Input formats : xml, json, html
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1CoreEntityProviderorg.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
5CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
6Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
7Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
8Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
9Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
10Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
11RESTfulorg.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
12Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
13RequestStorableorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable
14Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
15Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
16Saveableorg.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
17Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

REST:: 1.0.1 SVN: $Revision$ : $Date$