Search API

For assistance, send an email to: askedna@edna.edu.au.

Please note: these services are also available using the edna generators.

Available Formats:

• HTML - Plain HTML Format [URL: http://api.edna.edu.au/search.html ]
• XML - XML Formats [URL: http://api.edna.edu.au/search.xml ]
  • XML - edna XML Format [URL: http://api.edna.edu.au/search.eol ]
  • XML - DSM XML Format [URL: http://api.edna.edu.au/search.dsm ]
• RSS - RSS Formats
  • RSS 0.91 Format [URL: http://api.edna.edu.au/search.rss091 ]
  • RSS 2.0 Format [URL: http://api.edna.edu.au/search.rss20 ]

Parameters:

• q - Query text, '+' delimited [MANDATORY]
• sr - Source Resource (multiple) [edna (DEFAULT), gem, voced, merlot, fedgov, abcall]
• token - Token to access a particular result set. Not using this will result in slower page tree traversals. [OPTIONAL, however recommended]
• rset - Result Set Tab selector. Show this repository only. [OPTIONAL, DEFAULT most relevant results]
• start - Start result number for this page. [OPTIONAL, 1 (DEFAULT) - 201]
• mr - Maximum Results. [OPTIONAL, 100 (DEFAULT) - 200]
• cs - Case Sensitive. [OPTIONAL false (DEFAULT), true]
• kc - Keyword Constraint. [OPTIONAL all (DEFAULT), any, phrase]
• ss - Search Strategy. Wait for the first repository to finish only, wait for all repositories [OPTIONAL waitfast (DEFAULT), waitall]
• items - Number of items to display [OPTIONAL, 1-200, default 10]
• showdesc - Display Descriptions [OPTIONAL, true/false, default true]
• maxdesc - Maximum description length in characters [OPTIONAL, 1-3000, default 1000]
• popup - Popup links in a new window [OPTIONAL, true/false, default true]
• mode - Display mode: url (Title & Description), normal (Title, URL & Description) or full (Title, Relevance, Categories & Description) [OPTIONAL, url/normal/full, default full]
• showsource - Show the source of the result [OPTIONAL, true/false, default true]

Further information on parameters including examples

Extra Parameters (for HTML version only):

• header - URL of the header component in HTML. [OPTIONAL]
• footer - URL of the footer component in HTML. [OPTIONAL]

Header and footer examples

Legacy Service API Parameters:

• querytext - Query Text, '+' delimited [MANDATORY]
• word - [OPTIONAL: {all,any,phrase} all (DEFAULT)]
• sector - Category code [OPTIONAL] See Category codes
• dbset - [OPTIONAL: {edna,internal,external} edna (DEFAULT)]
• collection - [OPTIONAL: {help,help-ict}]
• ednacollection - [OPTIONAL: {portal,ict,nsep}]
• start - [OPTIONAL: 1 (DEFAULT)]
• count - [OPTIONAL: 10 (DEFAULT)]

---

edna services documentation