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

Custom Actions

getNoticeText : list (GET) : [/bbb-tool/getNoticeText] (html) (json) (txt)
isMeetingRunning : list (GET) : [/bbb-tool/isMeetingRunning] (html) (json) (txt)
getSettings : list (GET) : [/bbb-tool/getSettings] (html) (json) (txt)
getSiteRecordings : list (GET) : [/bbb-tool/getSiteRecordings] (html) (json) (txt)
protectRecordings : list (GET) : [/bbb-tool/protectRecordings] (html) (json) (txt)
joinMeeting : show (GET) : [/bbb-tool/:ID:/joinMeeting] (html) (json) (txt)
getUserSelectionOptions : list (GET) : [/bbb-tool/getUserSelectionOptions] (html) (json) (txt)
getRecordings : show (GET) : [/bbb-tool/:ID:/getRecordings] (html) (json) (txt)
recordingReady : new (POST) : [/bbb-tool/recordingReady]
getMeetings : list (GET) : [/bbb-tool/getMeetings] (html) (json) (txt)
endMeeting : list (GET) : [/bbb-tool/endMeeting] (html) (json) (txt)
removeUpload : list (GET) : [/bbb-tool/removeUpload] (html) (json) (txt)
publishRecordings : list (GET) : [/bbb-tool/publishRecordings] (html) (json) (txt)
getMeetingInfo : show (GET) : [/bbb-tool/:ID:/getMeetingInfo] (html) (json) (txt)
deleteRecordings : list (GET) : [/bbb-tool/deleteRecordings] (html) (json) (txt)
doUpload : new (POST) : [/bbb-tool/doUpload]
getJoinMeetingUrl : show (GET) : [/bbb-tool/:ID:/getJoinMeetingUrl] (html) (json) (txt)
getGroups : list (GET) : [/bbb-tool/getGroups] (html) (json) (txt)

Entity class : org.sakaiproject.bbb.api.BBBMeeting

Type :: bean
Name Type Status
1) attendeePasswordstringRead/Write
2) deletedbooleanRead/Write
3) endDatejava.util.DateRead/Write
4) groupSessionsbooleanRead/Write
5) hostUrlstringRead/Write
6) idstringRead/Write
7) joinUrlstringRead/Write
8) metajava.util.MapRead/Write
9) moderatorPasswordstringRead/Write
10) multipleSessionsAllowedbooleanRead/Write
11) namestringRead/Write
12) ownerDisplayNamestringRead/Write
13) ownerIdstringRead/Write
14) participantsjava.util.ListRead/Write
15) presentationstringRead/Write
16) propertiesorg.sakaiproject.entity.api.ResourcePropertiesRead Only
17) propsorg.sakaiproject.bbb.api.PropsRead/Write
18) recordingbooleanRead/Write
19) recordingDurationlongRead/Write
20) recordingEmailstringRead/Write
21) referencestringRead Only
22) siteIdstringRead/Write
23) startDatejava.util.DateRead/Write
24) urlstringRead Only
25) voiceBridgeintRead/Write
26) waitForModeratorbooleanRead/Write
27) welcomeMessagestringWrite Only

Data and Request Handling

Output formats : html, json, txt
Input formats : html, json
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
4AutoRegisterEntityProviderorg.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider
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
11Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
12Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
13Statisticableorg.sakaiproject.entitybroker.entityprovider.capabilities.Statisticable
14Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

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