Directory Resources Service

From n² wiki

Jump to: navigation, search

Represents the collection of resource descriptions maintained by the directory

URI
http://api.talis.com/1/dir/res
Allowed Methods
GET
Status
Public
Public Documentation
http://www.talis.com/tdn/platform/reference/api/directory-resources

Notes

This service differs from the Directory Collections Service, Directory Locations Service and the Directory Services Service because it only returns shallow descriptions whereas those services return deep descriptions. See Shallow and Deep Descriptions

GET

Returns simple RDF descriptions of the specified resources ordered by the resource URI.

Required Parameters

  • api_key - the user's API key

Optional Parameters

  • uri - describe resource with this URI
  • group - a space delimited list of group URIs. The list of descriptions will be restricted to those resources that are members of this group.
  • xsl - the URL of an XSL stylesheet to apply to the output

Future Planned Parameters

  • search - describe resources whose titles and descriptions contain these search terms
  • max - an integer specifying the maximum number of records to return
  • output - a string representing the format of the output. Only one output format is currently supported: 'rdf'. This is the default format if no other is specified

HTTP Response Notes

  • 200 - the request was successful, the descriptions are returned in the response
  • 403 - the request failed because the api_key was invalid
  • 500 - the request failed due to an internal server error

Examples

Show the RDF/XML for resources in the European Library group
GET http://api.talis.com/1/dir/res?group=http://directory.talis.com/res/r1161623142313%23self&api_key=112233445566
Show the RDF/XML for the European Library group resource
GET http://api.talis.com/1/dir/res?uri=http://directory.talis.com/res/r1161623142313%23self&api_key=112233445566
Personal tools