eval-evaluation (xml)

This allows you to perform operations on evaluations.
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 /eval-evaluation (json) (xml)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Searchs for all evaluations for the current user. Accepts parameters of: active - boolean, if true only return the active evaluations, untaken - boolean, if true only return the untaken evaluations, anonymous - boolean, if true include the evaluations for anonymous .
Create Entity URL: POST /eval-evaluation
Response Code Details: 201 plus id (EntityId); 400 if inputs invalid
Show Entity URL: GET /eval-evaluation/:ID: (json) (xml)
Response Code Details: 200 plus data; 404 if not found, 406 if format unavailable
Gets an evaluation is the current user can control it.
Update Entity URL: PUT /eval-evaluation/:ID:
Response Code Details: 204; 400 if inputs invalid
Delete Entity URL: DELETE /eval-evaluation/:ID:
Response Code Details: 204; 404 if not found

Entity class : org.sakaiproject.evaluation.model.EvalEvaluation

Type :: bean
Name Type Status
1) allRolesParticipatebooleanRead/Write
2) authControlstringRead/Write
3) autoUseInsertionstringRead/Write
4) autoUseTagstringRead/Write
5) availableEmailTemplateorg.sakaiproject.evaluation.model.EvalEmailTemplateRead/Write
6) blankResponsesAllowedbooleanRead/Write
7) currentReminderStatusorg.sakaiproject.evaluation.logic.model.EvalReminderStatusRead/Write
8) customStartDatebooleanRead/Write
9) dueDatejava.util.DateRead/Write
10) eidstringRead/Write
11) evalAssignGroupsjava.util.ListRead/Write
12) evalCategorystringRead/Write
13) idlongRead/Write
14) instructionsstringRead/Write
15) instructorOptstringRead/Write
16) instructorViewResultsbooleanRead/Write
17) instructorsDatejava.util.DateRead/Write
18) lastModifiedjava.util.DateRead/Write
19) lockedbooleanRead/Write
20) modifyResponsesAllowedbooleanRead/Write
21) ownerstringRead/Write
22) reminderDaysintRead/Write
23) reminderDaysIntintRead Only
24) reminderEmailTemplateorg.sakaiproject.evaluation.model.EvalEmailTemplateRead/Write
25) reminderFromEmailstringRead/Write
26) reminderStatusstringRead/Write
27) responsesjava.util.SetRead/Write
28) resultsSharingstringRead/Write
29) safeDueDatejava.util.DateRead Only
30) safeStopDatejava.util.DateRead Only
31) safeViewDatejava.util.DateRead Only
32) selectionOptionsjava.util.MapRead Only
33) selectionSettingsstringRead/Write
34) sendAvailableNotificationsbooleanRead/Write
35) startDatejava.util.DateRead/Write
36) statestringRead/Write
37) stopDatejava.util.DateRead/Write
38) studentViewResultsbooleanRead/Write
39) studentsDatejava.util.DateRead/Write
40) templateorg.sakaiproject.evaluation.model.EvalTemplateRead/Write
41) termIdstringRead/Write
42) titlestringRead/Write
43) typestringRead/Write
44) unregisteredAllowedbooleanRead/Write
45) useDueDatebooleanRead/Write
46) useStopDatebooleanRead/Write
47) useViewDatebooleanRead/Write
48) viewDatejava.util.DateRead/Write

Data and Request Handling

Output formats : json, xml
Input formats : json, xml
Access Provider available for request processing : EntityViewAccessProvider
Access Provider available for request processing : EntityViewAccessProvider

Capabilities

NameTypeDescription
1CoreEntityProviderorg.sakaiproject.entitybroker.entityprovider.CoreEntityProvider
2EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
3ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
5CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
6CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
7Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
8Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
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
18EvaluationEntityProviderorg.sakaiproject.evaluation.logic.entity.EvaluationEntityProvider

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