mySignup (xml)

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

URL Redirects

1)   /mySignup/user/{userId} ==> /direct/mySignup{dot-extension}

Entity class : org.sakaiproject.signup.restful.SignupEvent

Type :: bean
Name Type Status
1) allocToTSidstringRead/Write
2) allowAttendancebooleanRead/Write
3) allowCommentbooleanRead/Write
4) allowWaitListbooleanRead/Write
5) allowedUserActionTypes[Ljava.lang.String;Read/Write
6) autoReminderbooleanRead/Write
7) availableStatusstringRead/Write
8) currentUserSignedUpbooleanRead/Write
9) datejava.util.DateRead Only
10) descriptionstringRead/Write
11) eidInputModebooleanRead/Write
12) endTimejava.util.DateRead/Write
13) eventIdlongRead/Write
14) idstringRead/Write
15) locationstringRead/Write
16) maxNumOfSlotsintRead/Write
17) maxNumberOfAttendeesintRead Only
18) meetingCrossDaysbooleanRead Only
19) meetingExpiredbooleanRead Only
20) meetingTypestringRead/Write
21) myEndTimejava.util.DateRead/Write
22) mySignupEventsbooleanRead Only
23) myStartTimejava.util.DateRead/Write
24) noOfTimeSlotsintRead Only
25) organizerNamestringRead/Write
26) passedDeadlinebooleanRead Only
27) permissionorg.sakaiproject.signup.logic.PermissionRead/Write
28) propertiesorg.sakaiproject.entity.api.ResourcePropertiesRead Only
29) recurrenceIdlongRead/Write
30) referencestringRead Only
31) repeatTypestringRead/Write
32) serverUrlstringRead Only
33) signupBeginsjava.util.DateRead/Write
34) signupDeadlinejava.util.DateRead/Write
35) signupMainEventAttachItemsjava.util.ListRead/Write
36) signupSiteItemsjava.util.ListRead/Write
37) signupTimeSlotItemsjava.util.ListRead/Write
38) siteIdstringRead/Write
39) startTimejava.util.DateRead/Write
40) startToSignUpbooleanRead Only
41) titlestringRead/Write
42) urlstringRead Only
43) userActionTypestringRead/Write
44) userActionWarningMsgstringRead/Write

Data and Request Handling

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

Capabilities

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

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