url (xml)

An entity provider to allow shortening of URLs via the ShortenedUrlService
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

shorten : list (GET) : [/url/shorten]
Shorten a given URL using the configured implementation. The URL should be passed in via the 'path' URL parameter and should be URL encoded. If you want to use the 'secure' method (RandomisedUrlService only), also pass it as a URL parameter and use true|false as the value. Note that by default, for security reasons, external URLs cannot be shortened. If you want to allow this, set shortenedurl.external.enabled=true in sakai.properties.

Data and Request Handling

Output formats : No formats allowed
Input formats : No formats allowed
No Access Provider registered for request processing



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