|
[Print-friendly version]
OAKList API Reference
Welcome to the OAKList DEMO API reference page.
A brief technical outline of this API can be found in the API Documentation : MAN_OAKListAPIReference_v003_20080205_JS.pdf (209kb).
A number of demo functions are available from this menu.
-
When an external application uses OAKList data, it is important to know how is responsible for the system and where it is located. These fields are configured by the maintainer of the OAKList inside the administrative interface.
-
The most useful function of the API is the provision of a complete list of active OAKList records to the external application. These can then be cached locally for searching inside the external application.
-
In some cases, a tailored list of active OAKList records may need to be retrieved from an external application. The search function permits this with a flexible query string that can produce extremely specific lists of OAKList records for use in repository lookups or other situations.
By default, the API returns only those records stored in the OAKList.
If you would like to search all externally linked providers of data, there is a parameter that can be appended to the request string to do this. Limited information about external providers will be returned in these situations. This is to encourage externally linking applications to retrieve further information from the sources themselves.
Example Searches
Thank you for examining the OAKList please direct any comments on the API functionality to Joseph Stewart (jw.stewart@qut.edu.au).
Regards,
The OAKList Team
|
