Directory Services Service

From n² wiki

Jump to: navigation, search

Represents the collection of service descriptions maintained by the directory.

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


[edit] GET

Returns an extended RDF description of the specified services ordered by the service URIs

Required Parameters

  • api_key - the user's API key

Optional Parameters

  • uri - describe service with this URI
  • search - describe services whose titles and descriptions contain these search terms
  • xsl - the URL of an XSL stylesheet to apply to the output

Future Planned Parameters

  • 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
  • max - an integer specifying the maximum number of services to return
  • group - a space delimited list of group URIs. The list of descriptions will be restricted to those services that are members of this group.

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 Treasures SRU service
GET http://api.talis.com/1/dir/services?uri=http://directory.talis.com/res/id070109k18%23self&api_key=112233445566
Show the RDF/XML for all services matching the search term 'prism'
GET http://api.talis.com/1/dir/services?search=prism&api_key=112233445566
Personal tools