Describe Entities

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 /poll (xml) (json)

Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Deprecated. Use polls entity provider. Gets all the polls that the current user can take in all sites, limit to a specific site using 'siteId' or 'siteReference', switch to the polls a user can control (administrate) using 'admin' (boolean) set to true

Create Entity URL: POST /poll

Response Code Details: 201 plus id (EntityId); 400 if inputs invalid

Deprecated. Use polls entity provider.

Show Entity URL: GET /poll/:ID: (xml) (json)

Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable

Deprecated. Use polls entity provider. Gets a single poll by the pollId (the long, not the UUID string), returns only the poll itself by default, add in the options using 'includeOptions' (boolean), add in the votes using 'includeVotes' (boolean)

Update Entity URL: PUT /poll/:ID:

Response Code Details: 204; 400 if inputs invalid

Deprecated. Use polls entity provider.

Delete Entity URL: DELETE /poll/:ID:

Response Code Details: 204; 404 if not found

Deprecated. Use polls entity provider.

URL Redirects

1) /poll/{pollId}/vote ==> /direct/poll-vote{dot-extension}

Deprecated. Use polls entity provider. Gets all the votes for a specific poll

2) /poll/{pollId}/option ==> /direct/poll-option{dot-extension}

Deprecated. Use polls entity provider. Gets all the options for a specific poll

3) /poll/site/{siteId} ==> /direct/poll{dot-extension}

Deprecated. Use polls entity provider. Gets all the polls the current user can take in the given site

Entity class : org.sakaiproject.poll.model.Poll

Type :: bean

	Name	Type	Status
1)	creationDate	java.util.Date	Read/Write
2)	currentUserVoted	boolean	Read/Write
3)	description	string	Read/Write
4)	details	string	Read/Write
5)	displayResult	string	Read/Write
6)	id	string	Read/Write
7)	isPublic	boolean	Read/Write
8)	limitVoting	boolean	Read/Write
9)	maxOptions	int	Read/Write
10)	minOptions	int	Read/Write
11)	options	java.util.List	Read/Write
12)	owner	string	Read/Write
13)	pollId	long	Read/Write
14)	properties	org.sakaiproject.entity.api.ResourceProperties	Read Only
15)	reference	string	Read Only
16)	siteId	string	Read/Write
17)	text	string	Read/Write
18)	url	string	Read Only
19)	voteClose	java.util.Date	Read/Write
20)	voteCloseStr	string	Read/Write
21)	voteOpen	java.util.Date	Read/Write
22)	voteOpenStr	string	Read/Write
23)	votes	java.util.List	Read/Write

	Name	Type
1	CoreEntityProvider	org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2	EntityProvider	org.sakaiproject.entitybroker.entityprovider.EntityProvider
3	ActionsExecutable	org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4	CRUDable	org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
5	CollectionResolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
6	Createable	org.sakaiproject.entitybroker.entityprovider.capabilities.Createable
7	Deleteable	org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
8	Describeable	org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
9	Inputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
10	Outputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
11	RESTful	org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
12	RedirectDefinable	org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable
13	Redirectable	org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
14	RequestStorable	org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable
15	Resolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
16	Sampleable	org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
17	Saveable	org.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
18	Updateable	org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

poll (xml)

Sample Entity URLs (_id=':ID:') [may not be valid]:

URL Redirects

Entity class : org.sakaiproject.poll.model.Poll

Data and Request Handling

Capabilities