Directory Collections Service

From n² wiki

Jump to: navigation, search

Represents the collection of collection descriptions maintained by the directory

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


[edit] GET

Returns an extended RDF description of the specified collections

Required Parameters

  • api_key - the user's API key

Optional Parameters

  • uri - describe collection with this URI
  • search - describe collections whose titles and descriptions contain these search terms
  • identifier - a space delimited list of collection identifiers. The list of descriptions will be restricted to collections with those identifiers.
  • group - a space delimited list of group URIs. The list of descriptions will be restricted to those collections that are members of this group.
  • xsl - the URL of an XSL stylesheet to apply to the output

Future Planned Parameters

  • max - an integer specifying the maximum number of collections 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

[edit] Examples

Show the RDF/XML for the British Library collection
GET http://api.talis.com/1/dir/collections?uri=http://directory.talis.com/res/id070109k18%23self&api_key=112233445566
Show the RDF/XML for collections matching the term 'treasure'
GET http://api.talis.com/1/dir/collections?search=treasure&api_key=112233445566
Show the RDF/XML for collections with identifiers 'u116.inst' and '4046.inst'
GET http://api.talis.com/1/dir/collections?identifier=u116.inst+4046.inst&api_key=112233445566
Show the RDF/XML for collections in the European Library group
GET http://api.talis.com/1/dir/collections?group=http://directory.talis.com/res/r1161623142313%23self&api_key=112233445566
Personal tools