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

URL Redirects

1)   /sam_pub/context/{siteId} ==> /direct/sam_pub{dot-extension}

Data and Request Handling

Output formats : xml, json
Input formats : xml, json, html
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
5BrowseSearchableorg.sakaiproject.entitybroker.entityprovider.capabilities.BrowseSearchable
6Browseableorg.sakaiproject.entitybroker.entityprovider.capabilities.Browseable
7CRUDableorg.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable
8CollectionResolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable
9Createableorg.sakaiproject.entitybroker.entityprovider.capabilities.Createable
10Deleteableorg.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable
11Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
12Inputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Inputable
13Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
14PropertyProvideableorg.sakaiproject.entitybroker.entityprovider.capabilities.PropertyProvideable
15Propertyableorg.sakaiproject.entitybroker.entityprovider.capabilities.Propertyable
16RESTfulorg.sakaiproject.entitybroker.entityprovider.capabilities.RESTful
17RedirectDefinableorg.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable
18Redirectableorg.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable
19Resolvableorg.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable
20Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable
21Saveableorg.sakaiproject.entitybroker.entityprovider.capabilities.Saveable
22Updateableorg.sakaiproject.entitybroker.entityprovider.capabilities.Updateable
23PublishedAssessmentEntityProviderorg.sakaiproject.tool.assessment.entity.api.PublishedAssessmentEntityProvider

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