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
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Custom Actions
vote :
new (POST) :
[/poll-vote/vote]
Entity class : org.sakaiproject.poll.api.model.Vote
Type :: bean
|
Name |
Type |
Status |
| 1) | id | java.lang.Object | Read/Write |
| 2) | ip | string | Read/Write |
| 3) | option | org.sakaiproject.poll.api.model.Option | Read/Write |
| 4) | submissionId | string | Read/Write |
| 5) | userId | string | Read/Write |
| 6) | voteDate | java.time.Instant | Read/Write |
Data and Request Handling
Output formats : xml, json, form
Input formats : xml, json, html
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 | CollectionResolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable | |
| 5 | Createable | org.sakaiproject.entitybroker.entityprovider.capabilities.Createable | |
| 6 | Describeable | org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable | |
| 7 | Inputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable | |
| 8 | Outputable | org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable | |
| 9 | Redirectable | org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable | |
| 10 | Resolvable | org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable | |
| 11 | Sampleable | org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable | |
REST:: 1.0.1 SVN: $Revision$ : $Date$