annotate restService/templates/serviceDescription.html @ 26:f9391feb92ca

Service description updates
author dwinter
date Wed, 13 Mar 2013 10:39:21 +0100
parents 9ef155b1eec5
children aced422ae66c a25bfc49a068
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
1 <h1>PURL service</h1>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
2
a2bcca6539fd static pages
dwinter
parents:
diff changeset
3 <h2>/purl/PURL</h2>
26
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
4 <p> Takes a <em>PURL</em> and returns the real path as TXT.
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
5
24
9ef155b1eec5 description added
dwinter
parents: 22
diff changeset
6 <h2>/imagePath/PURL</h2>
26
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
7 <p> Takes a <em>PURL</em> and returns the image Path as TXT, if stored, otherwise an empty string is returned.
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
8
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
9 h2>/imageURL/PURL</h2>
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
10 <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.
24
9ef155b1eec5 description added
dwinter
parents: 22
diff changeset
11
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
12 <h2>/search</h2>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
13 <p>needs a parameter ?q=PATH </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
15 <p>Searched the PURL or all PURLs, wich belong to the PATH the internal search format is "LIKE" </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
16
a2bcca6539fd static pages
dwinter
parents:
diff changeset
17 <h2>/docuview/PURL</h3>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
18
a2bcca6539fd static pages
dwinter
parents:
diff changeset
19 <p>Is explained
a2bcca6539fd static pages
dwinter
parents:
diff changeset
20 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>.
a2bcca6539fd static pages
dwinter
parents:
diff changeset
21 </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
22
a2bcca6539fd static pages
dwinter
parents:
diff changeset
23 <h4>Config</h4>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
24 The viewer configuration in stored in <em>viewer.config</em>.
a2bcca6539fd static pages
dwinter
parents:
diff changeset
25
a2bcca6539fd static pages
dwinter
parents:
diff changeset
26 <p> e.g.</p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
27 <pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
28 echo,http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?url=%s,http://echo.mpiwg-berlin.mpg.de/ECHOdocuViewfull?mode=imagepath&url=%s&viewMode=images
a2bcca6539fd static pages
dwinter
parents:
diff changeset
29 libcoll,http://libcoll.mpiwg-berlin.mpg.de/libviewa?url=%s,http://libcoll.mpiwg-berlin.mpg.de/libviewa?url=%s&viewMode=images
a2bcca6539fd static pages
dwinter
parents:
diff changeset
30 digilib,,http://digilib.mpiwg-berlin.mpg.de/digitallibrary/jquery/digilib.html?fn=%s
a2bcca6539fd static pages
dwinter
parents:
diff changeset
31 </pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
32
a2bcca6539fd static pages
dwinter
parents:
diff changeset
33 <p>The format is:
a2bcca6539fd static pages
dwinter
parents:
diff changeset
34
a2bcca6539fd static pages
dwinter
parents:
diff changeset
35 <pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
36 FLAVOUR,FULTEXTVIEWER,IMAGEVIEWER
a2bcca6539fd static pages
dwinter
parents:
diff changeset
37 </pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
38
a2bcca6539fd static pages
dwinter
parents:
diff changeset
39 </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
40
a2bcca6539fd static pages
dwinter
parents:
diff changeset
41 <h3>/indexMeta/PURL</h3>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
42 <p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
43 Redirects to the index.meta file of the source, if existing.
19
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
44 </p>
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
45
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
46
26
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
47
19
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
48 <h3>/getPurls</h3>
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
49 get new purls
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
50
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
51 GET: returns an simple web page to enter username and amount of purls needed
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
52
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
53 POST: expects the parameter "username" and "amount"", return list of purls
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
54
21
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
55 <h3>/purls/searchSolr?text-url-path=PATH</h3>
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
56
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
57 gives the path to the index.meta at the storage system as XML
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
58
22
f748e2b684c9 bug in xml output fixed
dwinter
parents: 21
diff changeset
59 eg. purls/searchSolr?text-url-path=/diverse/de/Einst_Beric_de_1907.xml
21
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
60
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
61 an additional parameter <b>format=short</b> suppresses the additional metadata in the output.
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
62
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
63
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
64