Describe Entities

blog-entry (xml)

Represents an entry in a web log (blog)

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

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

Create Entity URL: POST /blog-entry

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

Show Entity URL: GET /blog-entry/:ID: (xml) (json)

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

Update Entity URL: PUT /blog-entry/:ID:

Response Code Details: 204; 400 if inputs invalid

Delete Entity URL: DELETE /blog-entry/:ID:

Response Code Details: 204; 404 if not found

Entity class : org.sakaiproject.blogwow.model.BlogWowEntry

Type :: bean

	Name	Type	Status
1)	blog	org.sakaiproject.blogwow.model.BlogWowBlog	Read/Write
2)	dateCreated	java.util.Date	Read/Write
3)	dateModified	java.util.Date	Read/Write
4)	id	string	Read/Write
5)	ownerId	string	Read/Write
6)	privacySetting	string	Read/Write
	Sets the visibility of this entry: private - visible to owner only, leader - visible to owner and group leader (instructor) of group related to the container blog, group - visible to group or site related to container blog, public - visible to anyone (anonymous users as well)
7)	text	string	Read/Write
8)	title	string	Read/Write

Data and Request Handling

Output formats : xml, json

Input formats : html, xml, json

Access Provider available for request processing : EntityViewAccessProvider

Capabilities

	Name	Type	Description
1	BlogEntryEntityProvider	org.sakaiproject.blogwow.logic.entity.BlogEntryEntityProvider
2	CoreEntityProvider	org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
3	EntityProvider	org.sakaiproject.entitybroker.entityprovider.EntityProvider
4	ActionsExecutable	org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
5	AutoRegisterEntityProvider	org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
6	CRUDable	org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
7	CollectionResolvable	org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
8	Createable	org.sakaiproject.entitybroker.entityprovider.capabilities.Createable	When creating a new entry in a blog, you must supply the id of the blog to place the entry into in the 'blog.id' field in the entry
9	Deleteable	org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
10	Describeable	org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
11	Inputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
12	Outputable	org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
13	RESTful	org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
14	Redirectable	org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
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

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