MT 1587 : CSV export for cart and shelves, with the ability to define different expor...
[koha.git] / koha-tmpl / opac-tmpl / prog / en / modules / ilsdi.tmpl
1 <!-- TMPL_INCLUDE NAME="doc-head-open.inc" --><!-- TMPL_VAR NAME="LibraryNameTitle" DEFAULT="Koha Online" --> Catalog &rsaquo;  ISBD
2 <!-- TMPL_INCLUDE NAME="doc-head-close.inc" -->
3 </head>
4 <body>
5 <div id="doc3" class="yui-t<!-- TMPL_IF NAME="OpacNav" -->1<!-- TMPL_ELSE -->7<!-- /TMPL_IF -->">
6   <div id="bd">
7 <!-- TMPL_INCLUDE name="masthead.inc" -->
8
9         <div id="yui-main">
10           <div class="yui-b"><div class="yui-g">
11             <h1>ILS-DI</h1>
12             
13 <!-- TMPL_IF NAME="GetAvailability" -->
14
15                 <h2>GetAvailability</h2>
16                 <p>Given a set of bibliographic or item identifiers, returns a 
17                 list with availability of the items associated with the identifiers.</p>
18                 <h4>Parameters</h4>
19                 <dl>
20                     <dt><strong>id</strong> (Required)</dt>
21                     <dd>list of either bibliographic or item identifiers</dd>
22                     <dt><strong>id_type</strong> (Required)</dt>
23                     <dd>defines the type of record identifier being used in the request, possible values: 
24                         <ul>
25                             <li>bib</li>
26                             <li>item</li>
27                         </ul>
28                     </dd>
29                     <dt><strong>return_type</strong> (Optional)</dt>
30                     <dd>requests a particular level of detail in reporting availability, possible values: 
31                         <ul>
32                             <li>bib</li>
33                             <li>item</li>
34                         </ul>
35                     </dd>
36                     <dt><strong>return_fmt</strong> (Optional)</dt>
37                     <dd>requests a particular format or set of formats in reporting availability</dd>
38                 </dl>
39                 <h4>Example Call</h4>
40                 <a href="ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item">
41                     ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item
42                 </a>
43                 <h4>Example Response</h4>
44 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
45 &lt;dlf:collection
46   xmlns:dlf="http://diglib.org/ilsdi/1.1"
47   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
48   xsi:schemaLocation="http://diglib.org/ilsdi/1.1
49     http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd"&gt;
50   &lt;dlf:record&gt;
51     &lt;dlf:bibliographic id="1" /&gt;
52     &lt;dlf:items&gt;
53       &lt;dlf:item id="1"&gt;
54         &lt;dlf:simpleavailability&gt;
55           &lt;dlf:identifier&gt;1&lt;/dlf:identifier&gt;
56           &lt;dlf:availabilitystatus&gt;available&lt;/dlf:availabilitystatus&gt;
57           &lt;dlf:location&gt;Bibliothèque Jean Prunier&lt;/dlf:location&gt;
58         &lt;/dlf:simpleavailability&gt;
59       &lt;/dlf:item&gt;
60     &lt;/dlf:items&gt;
61   &lt;/dlf:record&gt;
62   &lt;dlf:record&gt;
63     &lt;dlf:bibliographic id="2" /&gt;
64     &lt;dlf:items&gt;
65       &lt;dlf:item id="2"&gt;
66         &lt;dlf:simpleavailability&gt;
67           &lt;dlf:identifier&gt;2&lt;/dlf:identifier&gt;
68           &lt;dlf:availabilitystatus&gt;available&lt;/dlf:availabilitystatus&gt;
69           &lt;dlf:location&gt;Bibliothèque Jean Prunier&lt;/dlf:location&gt;
70         &lt;/dlf:simpleavailability&gt;
71       &lt;/dlf:item&gt;
72     &lt;/dlf:items&gt;
73   &lt;/dlf:record&gt;
74   &lt;dlf:record&gt;
75     &lt;dlf:bibliographic id="99999" /&gt;
76     &lt;dlf:items&gt;
77       &lt;dlf:item id="99999"&gt;
78         &lt;dlf:simpleavailability&gt;
79           &lt;dlf:identifier&gt;99999&lt;/dlf:identifier&gt;
80
81           &lt;dlf:availabilitystatus&gt;unknown&lt;/dlf:availabilitystatus&gt;
82           &lt;dlf:availabilitymsg&gt;Error: could not retrieve availability for this ID&lt;/dlf:availabilitymsg&gt;
83         &lt;/dlf:simpleavailability&gt;
84       &lt;/dlf:item&gt;
85     &lt;/dlf:items&gt;
86   &lt;/dlf:record&gt;
87 &lt;/dlf:collection&gt;</pre>
88
89 <!-- TMPL_ELSIF NAME="GetRecords" -->
90
91                 <h2>GetRecords</h2>
92                 <p>Given a list of record identifiers, returns a list of record 
93                 objects that contain bibliographic information, as well as 
94                 associated holdings and item information. The caller may request 
95                 a specific metadata schema for the record objects to be returned. 
96                 This function behaves similarly to HarvestBibliographicRecords and 
97                 HarvestExpandedRecords in Data Aggregation, but allows quick, real 
98                 time lookup by bibliographic identifier.</p>
99                 <p>You can use OAI-PMH ListRecords instead of this service.</p>
100                 <h4>Parameters</h4>
101                 <dl>
102                     <dt><strong>id</strong> (Required)</dt>
103                     <dd>list of system record identifiers</dd>
104                     <dt><strong>id_type</strong> (Optional)</dt>
105                     <dd>Defines the metadata schema in which the records are 
106                     returned, possible values: 
107                         <ul>
108                             <li>MARCXML</li>
109                         </ul>
110                     </dd>
111                 </dl>
112                 <h4>Example Call</h4>
113                 <a href="ilsdi.pl?service=GetRecords&id=1+2+99999">
114                     ilsdi.pl?service=GetRecords&id=1+2+99999
115                 </a>
116                 <h4>Example Response</h4>
117 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
118 &lt;GetRecords&gt;
119   &lt;record&gt;
120     &lt;biblioitemnumber&gt;1&lt;/biblioitemnumber&gt;
121     &lt;isbn&gt;9782862749198&lt;/isbn&gt;
122     &lt;marcxml&gt;
123       &lt;record
124           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
125           xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
126           xmlns="http://www.loc.gov/MARC21/slim"&gt;
127         &lt;leader&gt;00397nac a22001451u 4500&lt;/leader&gt;
128         &lt;datafield tag="010" ind1=" " ind2=" "&gt;
129           &lt;subfield code="a"&gt;9782862749198&lt;/subfield&gt;
130         &lt;/datafield&gt;
131         &lt;datafield tag="090" ind1=" " ind2=" "&gt;
132           &lt;subfield code="a"&gt;1&lt;/subfield&gt;
133         &lt;/datafield&gt;
134         &lt;datafield tag="101" ind1=" " ind2=" "&gt;
135           &lt;subfield code="a"&gt;fre&lt;/subfield&gt;
136         &lt;/datafield&gt;
137         &lt;datafield tag="100" ind1=" " ind2=" "&gt;
138           &lt;subfield code="a"&gt;20080725              frey50       &lt;/subfield&gt;
139         &lt;/datafield&gt;
140         &lt;datafield tag="200" ind1=" " ind2=" "&gt;
141           &lt;subfield code="a"&gt;Jardins d'enfance&lt;/subfield&gt;
142           &lt;subfield code="b"&gt;LITT&lt;/subfield&gt;
143           &lt;subfield code="f"&gt;Abécassis, Eliette&lt;/subfield&gt;
144         &lt;/datafield&gt;
145         &lt;datafield tag="210" ind1=" " ind2=" "&gt;
146           &lt;subfield code="c"&gt;cherche midi éditeur&lt;/subfield&gt;
147           &lt;subfield code="d"&gt;11/2001&lt;/subfield&gt;
148         &lt;/datafield&gt;
149         &lt;datafield tag="215" ind1=" " ind2=" "&gt;
150           &lt;subfield code="a"&gt;180&lt;/subfield&gt;
151         &lt;/datafield&gt;
152         &lt;datafield tag="225" ind1=" " ind2=" "&gt;
153           &lt;subfield code="a"&gt;nouvelles&lt;/subfield&gt;
154         &lt;/datafield&gt;
155         &lt;datafield tag="995" ind1=" " ind2=" "&gt;
156           &lt;subfield code="9"&gt;1&lt;/subfield&gt;
157           &lt;subfield code="c"&gt;BIB&lt;/subfield&gt;
158           &lt;subfield code="2"&gt;0&lt;/subfield&gt;
159           &lt;subfield code="k"&gt;R ABE&lt;/subfield&gt;
160           &lt;subfield code="o"&gt;0&lt;/subfield&gt;
161           &lt;subfield code="e"&gt;Secteur Adulte&lt;/subfield&gt;
162           &lt;subfield code="b"&gt;BIB&lt;/subfield&gt;
163           &lt;subfield code="j"&gt;7786000200&lt;/subfield&gt;
164           &lt;subfield code="q"&gt;a&lt;/subfield&gt;
165           &lt;subfield code="r"&gt;2&lt;/subfield&gt;
166           &lt;subfield code="s"&gt;Achats&lt;/subfield&gt;
167         &lt;/datafield&gt;
168         &lt;controlfield tag="001"&gt;1&lt;/controlfield&gt;
169       &lt;/record&gt;
170     &lt;/marcxml&gt;
171     &lt;publicationyear&gt;2001&lt;/publicationyear&gt;
172     &lt;collectiontitle&gt;nouvelles&lt;/collectiontitle&gt;
173     &lt;pages&gt;180&lt;/pages&gt;
174     &lt;issues&gt;
175     &lt;/issues&gt;
176     &lt;itemtype&gt;LITT&lt;/itemtype&gt;
177     &lt;biblionumber&gt;1&lt;/biblionumber&gt;
178     &lt;timestamp&gt;2008-09-03 18:43:19&lt;/timestamp&gt;
179     &lt;cn_sort&gt;_&lt;/cn_sort&gt;
180     &lt;publishercode&gt;cherche midi éditeur&lt;/publishercode&gt;
181     &lt;reserves&gt;
182     &lt;/reserves&gt;
183     &lt;items&gt;
184       &lt;item&gt;
185         &lt;biblioitemnumber&gt;1&lt;/biblioitemnumber&gt;
186         &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
187         &lt;holdingbranchname&gt;Bibliothèque Jean Prunier&lt;/holdingbranchname&gt;
188         &lt;notforloan&gt;0&lt;/notforloan&gt;
189         &lt;replacementpricedate&gt;2008-08-20&lt;/replacementpricedate&gt;
190         &lt;itemnumber&gt;1&lt;/itemnumber&gt;
191         &lt;location&gt;Secteur Adulte&lt;/location&gt;
192         &lt;itemcallnumber&gt;R ABE&lt;/itemcallnumber&gt;
193         &lt;date_due&gt;&lt;/date_due&gt;
194         &lt;itemlost&gt;0&lt;/itemlost&gt;
195         &lt;datelastseen&gt;2008-08-20&lt;/datelastseen&gt;
196         &lt;homebranch&gt;BIB&lt;/homebranch&gt;
197         &lt;homebranchname&gt;Bibliothèque Jean Prunier&lt;/homebranchname&gt;
198         &lt;biblionumber&gt;1&lt;/biblionumber&gt;
199         &lt;holdingbranch&gt;BIB&lt;/holdingbranch&gt;
200         &lt;timestamp&gt;2008-08-20 17:15:51&lt;/timestamp&gt;
201         &lt;damaged&gt;0&lt;/damaged&gt;
202         &lt;cn_sort&gt;R_ABE&lt;/cn_sort&gt;
203         &lt;dateaccessioned&gt;2008-08-20&lt;/dateaccessioned&gt;
204       &lt;/item&gt;
205     &lt;/items&gt;
206   &lt;/record&gt;
207   &lt;record&gt;
208     &lt;biblioitemnumber&gt;2&lt;/biblioitemnumber&gt;
209     &lt;isbn&gt;9782265078031&lt;/isbn&gt;
210     &lt;marcxml&gt;
211       &lt;record
212           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
213           xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
214           xmlns="http://www.loc.gov/MARC21/slim"&gt;
215         &lt;leader&gt;00407nac a22001451u 4500&lt;/leader&gt;
216         &lt;datafield tag="010" ind1=" " ind2=" "&gt;
217           &lt;subfield code="a"&gt;9782265078031&lt;/subfield&gt;
218         &lt;/datafield&gt;
219         &lt;datafield tag="090" ind1=" " ind2=" "&gt;
220           &lt;subfield code="a"&gt;2&lt;/subfield&gt;
221         &lt;/datafield&gt;
222         &lt;datafield tag="101" ind1=" " ind2=" "&gt;
223           &lt;subfield code="a"&gt;fre&lt;/subfield&gt;
224         &lt;/datafield&gt;
225         &lt;datafield tag="100" ind1=" " ind2=" "&gt;
226           &lt;subfield code="a"&gt;20080725              frey50       &lt;/subfield&gt;
227         &lt;/datafield&gt;
228         &lt;datafield tag="200" ind1=" " ind2=" "&gt;
229           &lt;subfield code="a"&gt;(Les) tribulations d'une jeune divorcée&lt;/subfield&gt;
230           &lt;subfield code="b"&gt;LITT&lt;/subfield&gt;
231           &lt;subfield code="f"&gt;Abécassis, Eliette&lt;/subfield&gt;
232         &lt;/datafield&gt;
233         &lt;datafield tag="210" ind1=" " ind2=" "&gt;
234           &lt;subfield code="c"&gt;bussière&lt;/subfield&gt;
235           &lt;subfield code="d"&gt;01/2005&lt;/subfield&gt;
236         &lt;/datafield&gt;
237         &lt;datafield tag="215" ind1=" " ind2=" "&gt;
238           &lt;subfield code="a"&gt;306&lt;/subfield&gt;
239         &lt;/datafield&gt;
240         &lt;datafield tag="225" ind1=" " ind2=" "&gt;
241           &lt;subfield code="a"&gt;fleuve noir&lt;/subfield&gt;
242         &lt;/datafield&gt;
243         &lt;datafield tag="995" ind1=" " ind2=" "&gt;
244           &lt;subfield code="9"&gt;2&lt;/subfield&gt;
245           &lt;subfield code="c"&gt;BIB&lt;/subfield&gt;
246           &lt;subfield code="2"&gt;0&lt;/subfield&gt;
247           &lt;subfield code="k"&gt;R ABE&lt;/subfield&gt;
248           &lt;subfield code="o"&gt;0&lt;/subfield&gt;
249           &lt;subfield code="e"&gt;Secteur Adulte&lt;/subfield&gt;
250           &lt;subfield code="b"&gt;BIB&lt;/subfield&gt;
251           &lt;subfield code="j"&gt;7786004672&lt;/subfield&gt;
252           &lt;subfield code="q"&gt;a&lt;/subfield&gt;
253           &lt;subfield code="s"&gt;Achats&lt;/subfield&gt;
254         &lt;/datafield&gt;
255         &lt;controlfield tag="001"&gt;2&lt;/controlfield&gt;
256       &lt;/record&gt;
257     &lt;/marcxml&gt;
258     &lt;publicationyear&gt;2005&lt;/publicationyear&gt;
259     &lt;collectiontitle&gt;fleuve noir&lt;/collectiontitle&gt;
260     &lt;pages&gt;306&lt;/pages&gt;
261     &lt;issues&gt;
262     &lt;/issues&gt;
263     &lt;itemtype&gt;LITT&lt;/itemtype&gt;
264     &lt;biblionumber&gt;2&lt;/biblionumber&gt;
265     &lt;timestamp&gt;2008-09-03 18:43:19&lt;/timestamp&gt;
266     &lt;cn_sort&gt;_&lt;/cn_sort&gt;
267     &lt;publishercode&gt;bussière&lt;/publishercode&gt;
268     &lt;reserves&gt;
269     &lt;/reserves&gt;
270     &lt;items&gt;
271       &lt;item&gt;
272         &lt;biblioitemnumber&gt;2&lt;/biblioitemnumber&gt;
273         &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
274         &lt;holdingbranchname&gt;Bibliothèque Jean Prunier&lt;/holdingbranchname&gt;
275         &lt;notforloan&gt;0&lt;/notforloan&gt;
276         &lt;replacementpricedate&gt;2008-08-20&lt;/replacementpricedate&gt;
277         &lt;itemnumber&gt;2&lt;/itemnumber&gt;
278         &lt;location&gt;Secteur Adulte&lt;/location&gt;
279         &lt;itemcallnumber&gt;R ABE&lt;/itemcallnumber&gt;
280         &lt;date_due&gt;&lt;/date_due&gt;
281         &lt;itemlost&gt;0&lt;/itemlost&gt;
282         &lt;datelastseen&gt;2008-08-20&lt;/datelastseen&gt;
283         &lt;homebranch&gt;BIB&lt;/homebranch&gt;
284         &lt;homebranchname&gt;Bibliothèque Jean Prunier&lt;/homebranchname&gt;
285         &lt;biblionumber&gt;2&lt;/biblionumber&gt;
286         &lt;holdingbranch&gt;BIB&lt;/holdingbranch&gt;
287         &lt;timestamp&gt;2008-08-20 17:15:51&lt;/timestamp&gt;
288         &lt;damaged&gt;0&lt;/damaged&gt;
289         &lt;cn_sort&gt;R_ABE&lt;/cn_sort&gt;
290         &lt;dateaccessioned&gt;2008-08-20&lt;/dateaccessioned&gt;
291       &lt;/item&gt;
292     &lt;/items&gt;
293   &lt;/record&gt;
294   &lt;record&gt;RecordNotFound&lt;/record&gt;
295 &lt;/GetRecords&gt;</pre>
296
297 <!-- TMPL_ELSIF NAME="GetAuthorityRecords" -->
298
299                 <h2>GetAuthorityRecords</h2>
300                 <p>Given a list of authority record identifiers, returns a list 
301                 of record objects that contain the authority records. The function 
302                 user may request a specific metadata schema for the record objects.</p>
303                 <h4>Parameters</h4>
304                 <dl>
305                     <dt><strong>id</strong> (Required)</dt>
306                     <dd>list of authority record identifiers</dd>
307                     <dt><strong>schema</strong> (Optional)</dt>
308                     <dd>specifies the metadata schema of records to be returned, possible values: 
309                         <ul>
310                             <li>MARCXML</li>
311                         </ul>
312                     </dd>
313                 </dl>
314                 <h4>Example Call</h4>
315                 <a href="ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999">
316                     ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999
317                 </a>
318                 <h4>Example Response</h4>
319 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
320 &lt;GetAuthorityRecords&gt;
321   &lt;record
322     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
323     xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
324     xmlns="http://www.loc.gov/MARC21/slim"&gt;
325     &lt;leader&gt;00126nx  j2200073   4500 &lt;/leader&gt;
326     &lt;controlfield tag="001"&gt;1&lt;/controlfield&gt;
327     &lt;datafield tag="250" ind1=" " ind2=" "&gt;
328       &lt;subfield code="a"&gt;TECHNIQUE&lt;/subfield&gt;
329     &lt;/datafield&gt;
330     &lt;datafield tag="100" ind1=" " ind2=" "&gt;
331       &lt;subfield code="a"&gt;20071210afrey50      ba0&lt;/subfield&gt;
332     &lt;/datafield&gt;
333     &lt;datafield tag="152" ind1=" " ind2=" "&gt;
334       &lt;subfield code="b"&gt;NC&lt;/subfield&gt;
335     &lt;/datafield&gt;
336   &lt;/record&gt;
337   &lt;record
338     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
339     xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
340     xmlns="http://www.loc.gov/MARC21/slim"&gt;
341     &lt;leader&gt;00130nx  j2200073   4500 &lt;/leader&gt;
342     &lt;controlfield tag="001"&gt;2&lt;/controlfield&gt;
343     &lt;datafield tag="250" ind1=" " ind2=" "&gt;
344       &lt;subfield code="a"&gt;CHEMIN DE FER&lt;/subfield&gt;
345     &lt;/datafield&gt;
346     &lt;datafield tag="100" ind1=" " ind2=" "&gt;
347       &lt;subfield code="a"&gt;20071210afrey50      ba0&lt;/subfield&gt;
348     &lt;/datafield&gt;
349     &lt;datafield tag="152" ind1=" " ind2=" "&gt;
350       &lt;subfield code="b"&gt;NC&lt;/subfield&gt;
351     &lt;/datafield&gt;
352   &lt;/record&gt;
353   &lt;record&gt;RecordNotFound&lt;/record&gt;
354 &lt;/GetAuthorityRecords&gt;</pre>
355
356 <!-- TMPL_ELSIF NAME="LookupPatron" -->
357
358                 <h2>LookupPatron</h2>
359                 <p>Looks up a patron in the ILS by an identifier, and returns 
360                 the ILS identifier for that patron, aka the patron identifier.</p>
361                 <h4>Parameters</h4>
362                 <dl>
363                     <dt><strong>id</strong> (Required)</dt>
364                     <dd>an identifier used to look up the patron in Koha</dd>
365                     <dt><strong>id_type</strong> (Optional)</dt>
366                     <dd>the type of the identifier, possible values: 
367                         <ul>
368                             <li>cardnumber</li>
369                             <li>firstname</li>
370                             <li>userid</li>
371                             <li>borrowernumber</li>
372                         </ul>
373                     </dd>
374                 </dl>
375                 <h4>Example Call</h4>
376                 <a href="ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber">
377                     ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber
378                 </a>
379                 <h4>Example Response</h4>
380 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
381 &lt;LookupPatron&gt;
382   &lt;id&gt;419&lt;/id&gt;
383 &lt;/LookupPatron&gt;</pre>
384
385 <!-- TMPL_ELSIF NAME="AuthenticatePatron" -->
386
387                 <h2>AuthenticatePatron</h2>
388                 <p>Authenticates a user's login credentials and returns the identifier for the patron.</p>
389                 <h4>Parameters</h4>
390                 <dl>
391                     <dt><strong>username</strong> (Required)</dt>
392                     <dd>user's login identifier</dd>
393                     <dt><strong>password</strong> (Required)</dt>
394                     <dd>user's password</dd>
395                 </dl>
396                 <h4>Example Call</h4>
397                 <a href="ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul">
398                     ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul
399                 </a>
400                 <h4>Example Response</h4>
401 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
402 &lt;AuthenticatePatron&gt;
403   &lt;id&gt;419&lt;/id&gt;
404 &lt;/AuthenticatePatron&gt;</pre>
405
406 <!-- TMPL_ELSIF NAME="GetPatronInfo" -->
407
408                 <h2>GetPatronInfo</h2>
409                 <p>Returns specified information about the patron, based on 
410                 options in the request. This function can optionally return 
411                 patron's contact information, fine information, hold request 
412                 information, loan information, and messages.</p>
413                 <h4>Parameters</h4>
414                 <dl>
415                     <dt><strong>patron_id</strong> (Required)</dt>
416                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
417                     <dt><strong>show_contact</strong> (Optional, default 1)</dt>
418                     <dd>whether or not to return patron's contact information in the response</dd>
419                     <dt><strong>show_fines</strong> (Optional, default 0)</dt>
420                     <dd>whether or not to return fine information in the response</dd>
421                     <dt><strong>show_holds</strong> (Optional, default 0)</dt>
422                     <dd>whether or not to return hold request information in the response</dd>
423                     <dt><strong>show_loans</strong> (Optional, default 0)</dt>
424                     <dd>whether or not to return loan information request information in the response</dd>
425                 </dl>
426                 <h4>Example Call</h4>
427                 <a href="ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1">
428                     ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1
429                 </a>
430                 <h4>Example Response</h4>
431 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
432 &lt;GetPatronInfo&gt;
433   &lt;category_type&gt;A&lt;/category_type&gt;
434   &lt;categorycode&gt;ADUEXT&lt;/categorycode&gt;
435   &lt;borrowernumber&gt;419&lt;/borrowernumber&gt;
436   &lt;lost&gt;0&lt;/lost&gt;
437   &lt;branchcode&gt;BIB&lt;/branchcode&gt;
438   &lt;amountoutstanding&gt;6&lt;/amountoutstanding&gt;
439   &lt;description&gt;Adulte extérieur&lt;/description&gt;
440   &lt;title&gt;M&lt;/title&gt;
441   &lt;enrolmentperiod&gt;12&lt;/enrolmentperiod&gt;
442   &lt;charges&gt;6.00&lt;/charges&gt;
443   &lt;dateenrolled&gt;2009-03-04&lt;/dateenrolled&gt;
444   &lt;borrowernotes&gt;&lt;/borrowernotes&gt;
445   &lt;dateexpiry&gt;2010-03-04&lt;/dateexpiry&gt;
446   &lt;firstname&gt;Jean-André&lt;/firstname&gt;
447   &lt;gonenoaddress&gt;0&lt;/gonenoaddress&gt;
448   &lt;dateofbirth&gt;1984-06-08&lt;/dateofbirth&gt;
449   &lt;debarred&gt;0&lt;/debarred&gt;
450   &lt;branchname&gt;Bibliothèque Jean Prunier&lt;/branchname&gt;
451   &lt;surname&gt;SANTONI&lt;/surname&gt;
452   &lt;cardnumber&gt;815&lt;/cardnumber&gt;
453   &lt;initials&gt;JAS&lt;/initials&gt;
454   &lt;sort1&gt;CSP5&lt;/sort1&gt;
455   &lt;sex&gt;M&lt;/sex&gt;
456   &lt;loans&gt;
457     &lt;loan&gt;
458       &lt;lastreneweddate&gt;2009-04-03&lt;/lastreneweddate&gt;
459       &lt;isbn&gt;2253003689&lt;/isbn&gt;
460       &lt;borrowernumber&gt;419&lt;/borrowernumber&gt;
461       &lt;branchcode&gt;BIB&lt;/branchcode&gt;
462       &lt;itemnumber&gt;4454&lt;/itemnumber&gt;
463       &lt;date_due&gt;2009-05-06&lt;/date_due&gt;
464       &lt;barcode&gt;4765476&lt;/barcode&gt;
465       &lt;datelastseen&gt;2008-08-23&lt;/datelastseen&gt;
466       &lt;issuedate&gt;2008-08-23&lt;/issuedate&gt;
467       &lt;title&gt;L'Île au trésor&lt;/title&gt;
468       &lt;itemtype&gt;LITT&lt;/itemtype&gt;
469       &lt;author&gt;Robert Louis Stevenson&lt;/author&gt;
470       &lt;timestamp&gt;2009-04-03 14:46:10&lt;/timestamp&gt;
471       &lt;publishercode&gt;Librairie générale française&lt;/publishercode&gt;
472       &lt;datecreated&gt;2008-08-23&lt;/datecreated&gt;
473       &lt;totalrenewals&gt;11&lt;/totalrenewals&gt;
474       &lt;dateaccessioned&gt;2008-08-23&lt;/dateaccessioned&gt;
475       &lt;onloan&gt;2008-09-17&lt;/onloan&gt;
476       &lt;biblioitemnumber&gt;4483&lt;/biblioitemnumber&gt;
477       &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
478       &lt;notforloan&gt;0&lt;/notforloan&gt;
479       &lt;replacementpricedate&gt;2008-08-23&lt;/replacementpricedate&gt;
480       &lt;itemcallnumber&gt;RO STE&lt;/itemcallnumber&gt;
481       &lt;location&gt;Salle de lecture&lt;/location&gt;
482       &lt;itemlost&gt;0&lt;/itemlost&gt;
483       &lt;publicationyear&gt;1985&lt;/publicationyear&gt;
484       &lt;issues&gt;1&lt;/issues&gt;
485       &lt;homebranch&gt;BIB&lt;/homebranch&gt;
486       &lt;holdingbranch&gt;BIB&lt;/holdingbranch&gt;
487       &lt;biblionumber&gt;4483&lt;/biblionumber&gt;
488       &lt;renewals&gt;3&lt;/renewals&gt;
489       &lt;damaged&gt;0&lt;/damaged&gt;
490       &lt;cn_sort&gt;RO_STE&lt;/cn_sort&gt;
491       &lt;frameworkcode&gt;&lt;/frameworkcode&gt;
492       &lt;datelastborrowed&gt;2008-08-23&lt;/datelastborrowed&gt;
493     &lt;/loan&gt;
494     &lt;loan&gt;
495       &lt;lastreneweddate&gt;2009-03-17&lt;/lastreneweddate&gt;
496       &lt;isbn&gt;9782700017823&lt;/isbn&gt;
497       &lt;borrowernumber&gt;419&lt;/borrowernumber&gt;
498       &lt;branchcode&gt;BIB&lt;/branchcode&gt;
499       &lt;itemnumber&gt;4456&lt;/itemnumber&gt;
500       &lt;date_due&gt;2009-04-18&lt;/date_due&gt;
501       &lt;barcode&gt;2700017UUU&lt;/barcode&gt;
502       &lt;datelastseen&gt;2008-08-23&lt;/datelastseen&gt;
503       &lt;issuedate&gt;2008-08-23&lt;/issuedate&gt;
504       &lt;title&gt;La guitare en 10 leçons&lt;/title&gt;
505       &lt;itemtype&gt;LITT&lt;/itemtype&gt;
506       &lt;author&gt;Jon Buck&lt;/author&gt;
507       &lt;timestamp&gt;2009-03-17 16:48:14&lt;/timestamp&gt;
508       &lt;publishercode&gt;Gründ&lt;/publishercode&gt;
509       &lt;datecreated&gt;2008-08-23&lt;/datecreated&gt;
510       &lt;totalrenewals&gt;6&lt;/totalrenewals&gt;
511       &lt;dateaccessioned&gt;2008-08-23&lt;/dateaccessioned&gt;
512       &lt;notes&gt;La couv. porte en plus : "un guide simple et facile pour apprendre la guitare" | Glossaire. Index&lt;/notes&gt;
513       &lt;onloan&gt;2008-09-25&lt;/onloan&gt;
514       &lt;biblioitemnumber&gt;4486&lt;/biblioitemnumber&gt;
515       &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
516       &lt;notforloan&gt;0&lt;/notforloan&gt;
517       &lt;replacementpricedate&gt;2008-08-23&lt;/replacementpricedate&gt;
518       &lt;itemcallnumber&gt;787.87 BUC&lt;/itemcallnumber&gt;
519       &lt;location&gt;Salle de lecture&lt;/location&gt;
520       &lt;itemlost&gt;0&lt;/itemlost&gt;
521       &lt;publicationyear&gt;2007&lt;/publicationyear&gt;
522       &lt;issues&gt;1&lt;/issues&gt;
523       &lt;homebranch&gt;BIB&lt;/homebranch&gt;
524       &lt;holdingbranch&gt;BIB&lt;/holdingbranch&gt;
525       &lt;biblionumber&gt;4486&lt;/biblionumber&gt;
526       &lt;renewals&gt;3&lt;/renewals&gt;
527       &lt;damaged&gt;0&lt;/damaged&gt;
528       &lt;cn_sort&gt;78787_BUC&lt;/cn_sort&gt;
529       &lt;volume&gt;une méthode simple et facile pour apprendre la guitare&lt;/volume&gt;
530       &lt;frameworkcode&gt;&lt;/frameworkcode&gt;
531       &lt;datelastborrowed&gt;2008-08-23&lt;/datelastborrowed&gt;
532     &lt;/loan&gt;
533   &lt;/loans&gt;
534 &lt;/GetPatronInfo&gt;</pre>
535
536 <!-- TMPL_ELSIF NAME="GetPatronStatus" -->
537
538                 <h2>GetPatronStatus</h2>
539                 <p>Returns a patron's status information from Koha.</p>
540                 <h4>Parameters</h4>
541                 <dl>
542                     <dt><strong>patron_id</strong> (Required)</dt>
543                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
544                 </dl>
545                 <h4>Example Call</h4>
546                 <a href="ilsdi.pl?service=GetPatronStatus&patron_id=1">
547                     ilsdi.pl?service=GetPatronStatus&patron_id=1
548                 </a>
549                 <h4>Example Response</h4>
550 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
551 &lt;GetPatronStatus&gt;
552   &lt;expiry&gt;2010-03-04&lt;/expiry&gt;
553   &lt;status&gt;0&lt;/status&gt;
554   &lt;type&gt;ADUEXT&lt;/type&gt;
555 &lt;/GetPatronStatus&gt;</pre>
556
557 <!-- TMPL_ELSIF NAME="GetServices" -->
558
559                 <h2>GetServices</h2>
560                 <p>Returns information about the services available on a particular item for a particular patron.</p>
561                 <h4>Parameters</h4>
562                 <dl>
563                     <dt><strong>patron_id</strong> (Required)</dt>
564                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
565                     <dt><strong>item_id</strong> (Required)</dt>
566                     <dd>system item identifier</dd>
567                 </dl>
568                 <h4>Example Call</h4>
569                 <a href="ilsdi.pl?service=GetServices&patron_id=1&item_id=1">
570                     ilsdi.pl?service=GetServices&patron_id=1&item_id=1
571                 </a>
572                 <h4>Example Response</h4>
573 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
574 &lt;GetServices&gt;
575   &lt;AvailableFor&gt;title level hold&lt;/AvailableFor&gt;
576   &lt;AvailableFor&gt;item level hold&lt;/AvailableFor&gt;
577 &lt;/GetServices&gt;</pre>
578
579 <!-- TMPL_ELSIF NAME="RenewLoan" -->
580
581                 <h2>RenewLoan</h2>
582                 <p>Extends the due date for a patron's existing loan.</p>
583                 <h4>Parameters</h4>
584                 <dl>
585                     <dt><strong>patron_id</strong> (Required)</dt>
586                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
587                     <dt><strong>item_id</strong> (Required)</dt>
588                     <dd>system item identifier</dd>
589                     <dt><strong>desired_due_date</strong> (Required)</dt>
590                     <dd>the date the patron would like the item returned by</dd>
591                 </dl>
592                 <h4>Example Call</h4>
593                 <a href="ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1">
594                     ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1
595                 </a>
596                 <h4>Example Response</h4>
597 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
598 &lt;RenewLoan&gt;
599   &lt;success&gt;0&lt;/success&gt;
600   &lt;renewals&gt;5&lt;/renewals&gt;
601   &lt;date_due&gt;2009-05-11&lt;/date_due&gt;
602 &lt;/RenewLoan&gt;</pre>
603
604 <!-- TMPL_ELSIF NAME="HoldTitle" -->
605
606                 <h2>HoldTitle</h2>
607                 <p>Creates, for a patron, a title-level hold request on a given bibliographic record in Koha.</p>
608                 <h4>Parameters</h4>
609                 <dl>
610                     <dt><strong>patron_id</strong> (Required)</dt>
611                     <dd>the ILS identifier for the patron for whom the request is placed</dd>
612                     <dt><strong>bib_id</strong> (Required)</dt>
613                     <dd>the ILS identifier for the bibliographic record on which the request is placed</dd>
614                     <dt><strong>request_location</strong> (Required)</dt>
615                     <dd>IP address where the end user request is being placed</dd>
616                     <dt><strong>pickup_location</strong> (Optional)</dt>
617                     <dd>an identifier indicating the location to which to deliver the item for pickup</dd>
618                     <dt><strong>needed_before_date</strong> (Optional)</dt>
619                     <dd>date after which hold request is no longer needed</dd>
620                     <dt><strong>pickup_expiry_date</strong> (Optional)</dt>
621                     <dd>date after which item returned to shelf if item is not picked up</dd>
622                 </dl>
623                 <h4>Example Call</h4>
624                 <a href="ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1">
625                     ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1
626                 </a>
627                 <h4>Example Response</h4>
628 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
629 &lt;HoldTitle&gt;
630   &lt;title&gt;(les) galères de l'Orfèvre&lt;/title&gt;
631   &lt;date_available&gt;2009-05-11&lt;/date_available&gt;
632   &lt;pickup_location&gt;Bibliothèque Jean-Prunier&lt;/pickup_location&gt;
633 &lt;/HoldTitle&gt;</pre>
634
635 <!-- TMPL_ELSIF NAME="HoldItem" -->
636
637                 <h2>HoldItem</h2>
638                 <p>Creates, for a patron, an item-level hold request on a specific item of a bibliographic record Koha.</p>
639                 <h4>Parameters</h4>
640                 <dl>
641                     <dt><strong>patron_id</strong> (Required)</dt>
642                     <dd>the ILS identifier for the patron for whom the request is placed</dd>
643                     <dt><strong>bib_id</strong> (Required)</dt>
644                     <dd>the ILS identifier for the bibliographic record on which the request is placed</dd>
645                     <dt><strong>item_id</strong> (Required)</dt>
646                     <dd>the ILS identifier for the specific item on which the request is placed</dd>
647                     <dt><strong>pickup_location</strong> (Optional)</dt>
648                     <dd>an identifier indicating the location to which to deliver the item for pickup</dd>
649                     <dt><strong>needed_before_date</strong> (Optional)</dt>
650                     <dd>date after which hold request is no longer needed</dd>
651                     <dt><strong>pickup_expiry_date</strong> (Optional)</dt>
652                     <dd>date after which item returned to shelf if item is not picked up</dd>
653                 </dl>
654                 <h4>Example Call</h4>
655                 <a href="ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1">
656                     ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1
657                 </a>
658                 <h4>Example Response</h4>
659 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
660 &lt;HoldTitle&gt;
661   &lt;title&gt;(les) galères de l'Orfèvre&lt;/title&gt;
662   &lt;date_available&gt;2009-05-11&lt;/date_available&gt;
663   &lt;pickup_location&gt;Bibliothèque Jean-Prunier&lt;/pickup_location&gt;
664 &lt;/HoldTitle&gt;</pre>
665
666 <!-- TMPL_ELSIF NAME="CancelHold" -->
667
668                 <h2>CancelHold</h2>
669                 <p>Cancels an active hold request for the patron.</p>
670                 <h4>Parameters</h4>
671                 <dl>
672                     <dt><strong>patron_id</strong> (Required)</dt>
673                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
674                     <dt><strong>item_id</strong> (Required)</dt>
675                     <dd>system item identifier</dd>
676                 </dl>
677                 <h4>Example Call</h4>
678                 <a href="ilsdi.pl?service=CancelHold&patron_id=1&item_id=1">
679                     ilsdi.pl?service=CancelHold&patron_id=1&item_id=1
680                 </a>
681                 <h4>Example Response</h4>
682 <pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
683 &lt;CancelHold&gt;
684   &lt;message&gt;Canceled&lt;/message&gt;
685 &lt;/CancelHold&gt;</pre>
686
687 <!-- TMPL_ELSE -->
688
689                 <h2>Level 1: Basic Discovery Interfaces</h2>
690                 <ul>
691                     <li>HarvestBibliographicRecords <em>(Use OAI-PMH instead)</em></li>
692                     <li>HarvestExpandedRecords <em>(Use OAI-PMH instead)</em></li>
693                     <li><a href="ilsdi.pl?service=Describe&verb=GetAvailability">GetAvailability</a></li>
694                     <li>GoToBibliographicRequestPage <em>(Use OPAC instead)</em></li>
695                 </ul>
696                 <h2>Level 2: Elementary OPAC supplement</h2>
697                 <ul>
698                     <li>HarvestAuthorityRecords <em>(Use OAI-PMH instead)</em></li>
699                     <li>HarvestHoldingsRecords <em>(Use OAI-PMH instead)</em></li>
700                     <li><a href="ilsdi.pl?service=Describe&verb=GetRecords">GetRecords</a></li>
701                     <li>Search</li>
702                     <li>Scan</li>
703                     <li><a href="ilsdi.pl?service=Describe&verb=GetAuthorityRecords">GetAuthorityRecords</a></li>
704                     <li>OutputRewritablePage</li>
705                     <li>OutputIntermediateFormat</li>
706                 </ul>
707                 <h2>Level 3: Elementary OPAC alternative</h2>
708                 <ul>
709                     <li><a href="ilsdi.pl?service=Describe&verb=LookupPatron">LookupPatron</a></li>
710                     <li><a href="ilsdi.pl?service=Describe&verb=AuthenticatePatron">AuthenticatePatron</a></li>
711                     <li><a href="ilsdi.pl?service=Describe&verb=GetPatronInfo">GetPatronInfo</a></li>
712                     <li><a href="ilsdi.pl?service=Describe&verb=GetPatronStatus">GetPatronStatus</a></li>
713                     <li><a href="ilsdi.pl?service=Describe&verb=GetServices">GetServices</a></li>
714                     <li><a href="ilsdi.pl?service=Describe&verb=RenewLoan">RenewLoan</a></li>
715                     <li><a href="ilsdi.pl?service=Describe&verb=HoldTitle">HoldTitle</a></li>
716                     <li><a href="ilsdi.pl?service=Describe&verb=HoldItem">HoldItem</a></li>
717                     <li><a href="ilsdi.pl?service=Describe&verb=CancelHold">CancelHold</a></li>
718                     <li>RecallItem <em>(Not supported by Koha)</em></li>
719                     <li>CancelRecall <em>(Not supported by Koha)</em></li>
720                 </ul>
721                 <h2>Level 4: Robust/domain specific discovery platforms</h2>
722                 <ul>
723                     <li>SearchCourseReserves</li>
724                     <li>Explain</li>
725                 </ul>
726
727 <!-- /TMPL_IF -->
728
729           </div></div>
730         </div>
731         <!-- TMPL_IF NAME="OpacNav" -->
732         <div class="yui-b"><div class="container">
733         <!--TMPL_INCLUDE NAME="navigation.inc" -->
734         </div></div>
735         <!-- /TMPL_IF -->
736   </div>
737 </div>
738 <!-- TMPL_INCLUDE NAME="opac-bottom.inc" -->