Directory Locations Service

From n² wiki

Represents the collection of location descriptions maintained by the directory

URI

http://api.talis.com/1/dir/locations

Allowed Methods

GET

Status

Public

Public Documentation

http://www.talis.com/tdn/platform/reference/api/directory-locations

[edit] GET

Returns an extended RDF description of the specified locations ordered by the location URIs

Required Parameters

• api_key - the user's API key

Optional parameters

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

Future Planned Parameters

• max - an integer specifying the maximum number of locations 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
• group - a space delimited list of group URIs. The list of descriptions will be restricted to those locations 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 St. Pancras

GET http://api.talis.com/1/dir/locations?uri=http://directory.talis.com/res/pap060331-215%23self&api_key=112233445566

Show the RDF/XML for locations matching the term 'leeds'

GET http://api.talis.com/1/dir/locations?search=leeds&api_key=112233445566