syllabus (xml)

Represents the Syllabus tool
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 /syllabus (xml) (json)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Create Entity URL: POST /syllabus
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /syllabus/:ID: (xml) (json)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Update Entity URL: PUT /syllabus/:ID:
Response Code Details: 204; 400 if inputs invalid
Delete Entity URL: DELETE /syllabus/:ID:
Response Code Details: 204; 404 if not found

Custom Actions

site : list (GET) : [/syllabus/site] (xml) (json)
Gets the syllabus for a given site. If the Syllabus is a redirect, then the result will be an almost empty document with the URL specified. Otherwise the content of the syllabus will be returned in a structured document. Items returned for normal users will be only those with a posted status and within start and end datetime boundaries. If the user requesting the provider can update the site, then they can see all syllabus items.

Entity class : java.util.HashMap

Type :: map

Data and Request Handling

Output formats : xml, json
Input formats : xml, json, html
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
4CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
5CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
6Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
7Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
8DescribePropertiesableorg.sakaiproject.entitybroker.entityprovider.capabilities.DescribePropertiesable
9Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
10Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
11Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
12RESTfulorg.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
13Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
14Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
15Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
16Saveableorg.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
17Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

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