view restService/templates/serviceDescription.html @ 40:671dd1e4bd09 default tip

minor bug
author dwinter
date Wed, 05 Mar 2014 10:20:54 +0100
parents 6d0d7f1c11f2
children
line wrap: on
line source

<h1>PURL service</h1>

<h2>/purl/PURL</h2>
<p> Takes a <em>PURL</em>  and returns the real path as TXT.

<h2>/imagePath/PURL</h2>
<p> Takes a <em>PURL</em>  and returns the image Path as TXT, if stored, otherwise an empty string is returned.

<h2>/imageURL/PURL</h2>
<p> Takes a <em>PURL</em>  and returns the image URL at the scaler all parameters are passed through, if stored, otherwise an empty string is returned.

<h2>/search</h2>
<p>Searched the PURL or all PURLs, wich belong to the PATH the internal search format is "LIKE" </p>

<h3>GET</h3>
<p>needs a parameter ?q=PATH </p>

<h3>POST</h3>
<p>expects at \n separated list of paths and returns a list with the path and the purl.

<h2>/docuview/PURL</h3>

<p>Is explained 
at <a href="https://it-dev.mpiwg-berlin.mpg.de/tracs/metadataprovider/wiki/purls">https://it-dev.mpiwg-berlin.mpg.de/tracs/metadataprovider/wiki/purls</a>.
</p>

<h4>Config</h4>
The viewer configuration in stored in <em>viewer.config</em>.

<p> e.g.</p>
<pre>
echo,http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?url=%s,http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?mode=imagepath&url=%s&viewMode=images
libcoll,http://libcoll.mpiwg-berlin.mpg.de/libviewa?url=%s,http://libcoll.mpiwg-berlin.mpg.de/libviewa?url=%s&viewMode=images
digilib,,http://digilib.mpiwg-berlin.mpg.de/digitallibrary/jquery/digilib.html?fn=%s
</pre>

<p>The format is:

<pre>
FLAVOUR,FULTEXTVIEWER,IMAGEVIEWER
</pre>

</p>

<h3>/indexMeta/PURL</h3>
<p>
Redirects to the index.meta file of the source, if existing.
</p>



<h3>/getPurls</h3>
get new purls

GET: returns an simple web page to enter username and amount of purls needed

POST: expects the parameter "userName" and "amount"", return list of purls

<h3>/purls/searchSolr?text-url-path=PATH</h3>

gives the path to the index.meta at the storage system as XML

eg. purls/searchSolr?text-url-path=/diverse/de/Einst_Beric_de_1907.xml

an additional parameter <b>format=short</b> suppresses the additional metadata in the output.

<h4>/dris</h4>
<p>get a list of all DRIs.</p>

<p>
Optional parameters are:
<ol>
<li>offset: start list at offset</li>
<li>limit: limit number of entries return</li>
<li>format, is ether json or csv</li>
</ol>
</p>