portal-hierarchy (xml)

Represents a site and its immediate subsites, example partial URL: /direct/portal-hierarchy/site.json?portalpath=:central:it:test:adam
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)

Custom Actions

site : list (GET) : [/portal-hierarchy/site] (json) (xml) (html)
Retrieves a list of basic site information and the site's immediate subsites.
Example partial URLs:
/direct/portal-hierarchy/site.json?portalpath=:central:it:test:adam
/direct/portal-hierarchy/site.json?portalpath=%3Acentral%3Ait%3Atest%3Aadam
locations : list (GET) : [/portal-hierarchy/locations] (json) (xml) (html)
Retrieves a list of all portal nodes of a given site in the hierarchy.
Example partial URLs:
/direct/portal-hierarchy/locations.json?siteid=[id]
/direct/portal-hierarchy/locations.json?siteid=053c7ced-32e8-4932-a5ea-4908627ce690

Entity class : org.sakaiproject.hierarchy.tool.entityproviders.HierarchySiteSummary

Type :: bean
Name Type Status
1) redirectsjava.util.ListRead/Write
2) siteIdstringRead/Write
3) siteUrlstringRead/Write
4) subsitesjava.util.ListRead/Write

Data and Request Handling

Output formats : json, xml, html
Input formats : No formats allowed
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
4Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
5Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable
6Sampleableorg.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

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