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
URL Redirects
1) /profile/{id}/account ==> calculated destination
Entity class : org.sakaiproject.profile2.model.UserProfile
Type :: bean
|
Name |
Type |
Status |
1) | academicProfileUrl | string | Read/Write |
2) | birthday | string | Read/Write |
3) | birthdayDisplay | string | Read/Write |
4) | businessBiography | string | Read/Write |
5) | companyProfiles | java.util.List | Read/Write |
6) | course | string | Read/Write |
7) | dateOfBirth | java.util.Date | Read/Write |
8) | department | string | Read/Write |
9) | displayName | string | Read/Write |
10) | email | string | Read/Write |
11) | facsimile | string | Read/Write |
12) | favouriteBooks | string | Read/Write |
13) | favouriteMovies | string | Read/Write |
14) | favouriteQuotes | string | Read/Write |
15) | favouriteTvShows | string | Read/Write |
16) | formattedBirthday | string | Read/Write |
17) | homepage | string | Read/Write |
18) | homephone | string | Read/Write |
19) | imageThumbUrl | string | Read/Write |
20) | imageUrl | string | Read/Write |
21) | locked | boolean | Read/Write |
22) | mobilephone | string | Read/Write |
23) | nickname | string | Read/Write |
24) | personalSummary | string | Read/Write |
25) | phoneticPronunciation | string | Read/Write |
26) | position | string | Read/Write |
27) | pronouns | string | Read/Write |
28) | pronounsInput | string | Read/Write |
29) | pronounsSelected | string | Read/Write |
30) | props | java.util.Map | Read/Write |
31) | publications | string | Read/Write |
32) | room | string | Read/Write |
33) | school | string | Read/Write |
34) | socialInfo | org.sakaiproject.profile2.model.SocialNetworkingInfo | Read/Write |
35) | staffProfile | string | Read/Write |
36) | status | org.sakaiproject.profile2.model.ProfileStatus | Read/Write |
37) | subjects | string | Read/Write |
38) | universityProfileUrl | string | Read/Write |
39) | userUuid | string | Read/Write |
40) | workphone | string | Read/Write |
Data and Request Handling
Output formats : html, xml, json
Input formats : No formats allowed
No Access Provider registered for request processing
Capabilities
| Name | Type | Description |
1 | CoreEntityProvider | org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider | |
2 | EntityProvider | org.sakaiproject.entitybroker.entityprovider.EntityProvider | |
3 | ActionsExecutable | org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable | |
4 | AutoRegisterEntityProvider | org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider | |
5 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
6 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
7 | Redirectable | org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable | |
8 | RequestAware | org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware | |
9 | Resolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable | |
10 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$