koha-tmpl/opac-tmpl/prog/en/modules/ilsdi.tt

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