Naar inhoud springen

CampusSearch XML interface

Uit CampusWiki

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.

Undocumented features

Feeds

Feed met alle TV shows bekend bij Search, incl. IMDB ID.
Feed met TV Shows die afgelopen 30 dagen waren uitgezonden en gevonden op Search.
Feed met alle episodes van show met IMDB ID = tt0313038.

GET parameters

Doe een GET request naar http://search.student.utwente.nl/api/search.

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

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

Voorbeeld van XML uitvoer

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

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

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

<campus_search> 
	<status> 
		<status_msg>success</status_msg> 
	</status> 
	<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> 
	<result> 
		<rank>10</rank> 
		<netbios_name>WOLVERINE</netbios_name> 
		<ip>130.89.160.253</ip> 
		<type>directory</type> 
		<full_path>smb://130.89.160.253/FILMS/Animatrix</full_path> 
		<dir>FILMS</dir> 
		<name>Animatrix</name> 
		<online>yes</online> 
		<size>1457489248</size> 
		<meta> 
			<imdb_url>http://imdb.com/title/tt0328832</imdb_url> 
			<imdb_rating>7.5</imdb_rating> 
			<imdb_year>2003</imdb_year> 
		</meta> 
	</result> 
</campus_search>

Foutmeldingen

Een foutmelding ziet er als volgt uit: 

<campus_search> 
	<status> 
		<status_msg>error</status_msg> 
		<error_code>ERROR_SEARCH_NO_RESULTS</error_code> 
	</status> 
</campus_search>

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

Projecten die gebruik maken van het XML interface

Zet ook even je naam/e-mail hieronder, dan kunnen mensen contact met je opnemen.

Zie ook

Externe links

Overgenomen van "https://wiki.student.utwente.nl/w/index.php?title=CampusSearch_XML_interface&oldid=11812"