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

minor bug
author dwinter
date Wed, 05 Mar 2014 10:20:54 +0100
parents 6d0d7f1c11f2
children
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
33
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
9 <h2>/imageURL/PURL</h2>
26
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>
33
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
13 <p>Searched the PURL or all PURLs, wich belong to the PATH the internal search format is "LIKE" </p>
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
14
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
15 <h3>GET</h3>
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
16 <p>needs a parameter ?q=PATH </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
17
33
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
18 <h3>POST</h3>
aced422ae66c added post resquest for search
dwinter
parents: 26
diff changeset
19 <p>expects at \n separated list of paths and returns a list with the path and the purl.
14
a2bcca6539fd static pages
dwinter
parents:
diff changeset
20
a2bcca6539fd static pages
dwinter
parents:
diff changeset
21 <h2>/docuview/PURL</h3>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
22
a2bcca6539fd static pages
dwinter
parents:
diff changeset
23 <p>Is explained
a2bcca6539fd static pages
dwinter
parents:
diff changeset
24 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
25 </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
26
a2bcca6539fd static pages
dwinter
parents:
diff changeset
27 <h4>Config</h4>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
28 The viewer configuration in stored in <em>viewer.config</em>.
a2bcca6539fd static pages
dwinter
parents:
diff changeset
29
a2bcca6539fd static pages
dwinter
parents:
diff changeset
30 <p> e.g.</p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
31 <pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
32 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
33 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
34 digilib,,http://digilib.mpiwg-berlin.mpg.de/digitallibrary/jquery/digilib.html?fn=%s
a2bcca6539fd static pages
dwinter
parents:
diff changeset
35 </pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
36
a2bcca6539fd static pages
dwinter
parents:
diff changeset
37 <p>The format is:
a2bcca6539fd static pages
dwinter
parents:
diff changeset
38
a2bcca6539fd static pages
dwinter
parents:
diff changeset
39 <pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
40 FLAVOUR,FULTEXTVIEWER,IMAGEVIEWER
a2bcca6539fd static pages
dwinter
parents:
diff changeset
41 </pre>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
42
a2bcca6539fd static pages
dwinter
parents:
diff changeset
43 </p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
44
a2bcca6539fd static pages
dwinter
parents:
diff changeset
45 <h3>/indexMeta/PURL</h3>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
46 <p>
a2bcca6539fd static pages
dwinter
parents:
diff changeset
47 Redirects to the index.meta file of the source, if existing.
19
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
48 </p>
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
49
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
50
26
f9391feb92ca Service description updates
dwinter
parents: 24
diff changeset
51
19
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
52 <h3>/getPurls</h3>
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
53 get new purls
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
54
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
55 GET: returns an simple web page to enter username and amount of purls needed
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
56
34
a25bfc49a068 added format parameter
dwinter
parents: 26
diff changeset
57 POST: expects the parameter "userName" and "amount"", return list of purls
19
cce127a28fc9 added getpurls
dwinter
parents: 14
diff changeset
58
21
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
59 <h3>/purls/searchSolr?text-url-path=PATH</h3>
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 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
62
22
f748e2b684c9 bug in xml output fixed
dwinter
parents: 21
diff changeset
63 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
64
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
65 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
66
38
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
67 <h4>/dris</h4>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
68 <p>get a list of all DRIs.</p>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
69
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
70 <p>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
71 Optional parameters are:
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
72 <ol>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
73 <li>offset: start list at offset</li>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
74 <li>limit: limit number of entries return</li>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
75 <li>format, is ether json or csv</li>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
76 </ol>
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
77 </p>
21
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
78
90643ccc6545 cross scripting and xml mime-type
dwinter
parents: 19
diff changeset
79
38
6d0d7f1c11f2 /dris added to the api
dwinter
parents: 35
diff changeset
80