profile (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]:

Show Entity URL: GET /profile/:ID: (html) (xml) (json)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Custom Actions

removeFriend : show (GET) : [/profile/:ID:/removeFriend] (html) (xml) (json)
image : show (GET) : [/profile/:ID:/image] (html) (xml) (json)
friendStatus : show (GET) : [/profile/:ID:/friendStatus] (html) (xml) (json)
pronunciation : show (GET) : [/profile/:ID:/pronunciation] (html) (xml) (json)
confirmFriendRequest : show (GET) : [/profile/:ID:/confirmFriendRequest] (html) (xml) (json)
unreadMessagesCount : show (GET) : [/profile/:ID:/unreadMessagesCount] (html) (xml) (json)
incomingConnectionRequests : show (GET) : [/profile/:ID:/incomingConnectionRequests] (html) (xml) (json)
requestFriend : show (GET) : [/profile/:ID:/requestFriend] (html) (xml) (json)
outgoingConnectionRequests : show (GET) : [/profile/:ID:/outgoingConnectionRequests] (html) (xml) (json)
ignoreFriendRequest : show (GET) : [/profile/:ID:/ignoreFriendRequest] (html) (xml) (json)
connections : show (GET) : [/profile/:ID:/connections] (html) (xml) (json)

URL Redirects

1)   /profile/{id}/account ==> calculated destination

Entity class : org.sakaiproject.profile2.model.UserProfile

Type :: bean
Name Type Status
1) academicProfileUrlstringRead/Write
2) birthdaystringRead/Write
3) birthdayDisplaystringRead/Write
4) businessBiographystringRead/Write
5) companyProfilesjava.util.ListRead/Write
6) coursestringRead/Write
7) dateOfBirthjava.util.DateRead/Write
8) departmentstringRead/Write
9) displayNamestringRead/Write
10) emailstringRead/Write
11) facsimilestringRead/Write
12) favouriteBooksstringRead/Write
13) favouriteMoviesstringRead/Write
14) favouriteQuotesstringRead/Write
15) favouriteTvShowsstringRead/Write
16) formattedBirthdaystringRead/Write
17) homepagestringRead/Write
18) homephonestringRead/Write
19) imageThumbUrlstringRead/Write
20) imageUrlstringRead/Write
21) lockedbooleanRead/Write
22) mobilephonestringRead/Write
23) nicknamestringRead/Write
24) personalSummarystringRead/Write
25) phoneticPronunciationstringRead/Write
26) positionstringRead/Write
27) pronounsstringRead/Write
28) pronounsInputstringRead/Write
29) pronounsSelectedstringRead/Write
30) propsjava.util.MapRead/Write
31) publicationsstringRead/Write
32) roomstringRead/Write
33) schoolstringRead/Write
34) socialInfoorg.sakaiproject.profile2.model.SocialNetworkingInfoRead/Write
35) staffProfilestringRead/Write
36) statusorg.sakaiproject.profile2.model.ProfileStatusRead/Write
37) subjectsstringRead/Write
38) universityProfileUrlstringRead/Write
39) userUuidstringRead/Write
40) workphonestringRead/Write

Data and Request Handling

Output formats : html, xml, json
Input formats : No formats allowed
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
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
6Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
7Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
8RequestAwareorg.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware
9Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
10Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

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