CampusSearch XML interface

2009-09-24T14:22:18Z

130.89.102.46: /* Foutmeldingen */

__TOC__
Het is mogelijk om CampusSearch database te raadplegen via een GET-request, waarmee je een XML output kan genereren. Dit is de eerste versie van het geheel en zal zeker in de toekomst nog aangepast worden.

Als je gebruik maakt van dit interface, zet je project bij ''Projecten die gebruikt maken van het XML interface''.

Voor verdere vragen of uitbreidingen, neem contact op met [[ddofborg]].

== GET parameters ==
Doe een GET request naar <tt>http://search.student.utwente.nl/api/search</tt>.

Deze parameters worden ondersteund (de waarden van de GET-parameters moeten URL-encoded zijn):

* <tt>q</tt>: de zoek string, bijv. "The+Matrix" (<u>verplicht</u>).
* <tt>page</tt>: paginanummer, elke 'pagina' heeft 30 resultaten, beginnend bij 0 (0-29), dan 1 (30-59), etc.
* <tt>minsize</tt>: minimale grootte van de file/dir, bijv. 0.5M of 1G.
* <tt>maxsize</tt>: maximale grootte van de file/dir, bijv. 0.5M of 1G.
* <tt>dirsonly</tt> waarde 'yes' als je alleen op directories wilt zoeken.

== Voorbeeld van XML uitvoer ==
Voorbeeld, zoeken naar directories genaamd "The Matrix", met minimale grootte 0.5G en maximale grootte 2G:

<tt>http://search.student.utwente.nl/api/search?q=the+matrix&page=0&minsize=0.5G&maxsize=2G&dirsonly=yes</tt>

Een deel van de XML die uit komt is als volgt:

<pre>
<campus_search>
<result>
<rank>9</rank>
<netbios_name>NZSERVER</netbios_name>
<ip>130.89.162.28</ip>
<type>file</type>
<full_path>smb://130.89.162.28/Movies/IMDB top 30/30 - The Matrix/The Matrix [1].avi</full_path>
<dir>Movies/IMDB top 30/30 - The Matrix</dir>
<name>The Matrix [1].avi</name>
<online>no</online>
<size>735412224</size>
<meta>
<imdb_url>http://imdb.com/title/tt0133093</imdb_url>
<imdb_rating>8.7</imdb_rating>
<imdb_year>1999</imdb_year>
</meta>
</result>
</campus_search>
</pre>

== Foutmeldingen ==
Een foutmelding ziet er als volgt uit:

<pre>
<campus_search>
<result>
<status>error</status>
<error_code>ERROR_SEARCH_NO_RESULTS</error_code>
</result>
</campus_search>
</pre>

Element <tt>error_code</tt> kan een van de volgende waarden hebben: <tt>ERROR_SEARCH_NO_RESULTS</tt>of <tt>ERROR_SEARCH_INCORRECT_QUERY</tt>. Eerste geeft aan dat er geen resultaten gevonden zijn, de tweede dat de aanvraag niet volledig of incorrect was.

== Projecten die gebruikt maken van het XML interface ==
* ...

== Zie ook ==
* [[CampusSearch]]
* [[CampusSearch development]]

== Externe links ==
* http://search.student.utwente.nl/

[[Category:CampusSearch]]

CampusWiki - Gebruikersbijdragen [nl]

CampusSearch XML interface