Browse parameters

Available browse parameters

Parameter Name Description Value(s) Optional
id Category number See 4.2 No
catpath Path to get to category of choice See 4.8 Yes
items Number of items to display 1-100
defaults to 10
Yes
maxdesc Maximum description length in characters 1 - 3000
1000 is default
Yes
mode Display mode for Javascript and HTML format.
URL (Title & Description), normal (Title, URL & Description) or full (Title, Last Modified, Categories & Description)
URL
normal (Javascript default)
full (all other default)
Yes
popup Popup links in a new window

true (default)
false

Yes
showdesc Display descriptions true (default)
false
Yes
showdirectory Show the directory or breadcrumbs true (default)
false
Yes
start Start result number for this page 1 - 201
1 is default
Yes

Extra parameters

To customise the browse to your own look and feel, you can add the URLs of your own header and footer to wrap around the browse results returned.

If you don't add your own header and footer, a default edna-branded header and footer will be returned.

Parameter Name Description Value(s) Optional
header

 

URL of header HTML template. Only used if footer parameter is also supplied. Defaults to http://api.edna.edu.au/static/basic_header.html Yes
footer Path to get to category of choice Defaults to http://api.edna.edu.au/static/basic_footer.html Yes

edna category numbers for top level topics

Title Category Number
Adult and Community Education (ACE) 12691
Higher Education 14899
International Education 19179
School Education 3830
Vocational & Technical Education  (VTE) 12650
Educational Organisations 599
General References 528
ICT Research 13950
Technical Standards 19159
(Top Level) All edna 0