Bug 10667: Allow authentication with cardnumber for ILS-DI
[koha.git] / koha-tmpl / opac-tmpl / prog / en / modules / ilsdi.tt
index 8ee8b7b..a727b29 100644 (file)
@@ -1,4 +1,4 @@
-[% INCLUDE 'doc-head-open.inc' %][% LibraryNameTitle or "Koha Online" %] › ILS-DI
+[% INCLUDE 'doc-head-open.inc' %][% LibraryNameTitle or "Koha online" %] › ILS-DI
 [% INCLUDE 'doc-head-close.inc' %]
 </head>
 <body>
                     <dt><strong>return_fmt</strong> (Optional)</dt>
                     <dd>requests a particular format or set of formats in reporting availability</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item">
-                    ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=GetAvailability&amp;id=1+2+99999&amp;id_type=item">
+                    ilsdi.pl?service=GetAvailability&amp;id=1+2+99999&amp;id_type=item
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;dlf:collection
   xmlns:dlf="http://diglib.org/ilsdi/1.1"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                     </dd>
                 </dl>
                 <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetRecords&id=1+2+99999">
-                    ilsdi.pl?service=GetRecords&id=1+2+99999
+                <a href="ilsdi.pl?service=GetRecords&amp;id=1+2+99999">
+                    ilsdi.pl?service=GetRecords&amp;id=1+2+99999
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;GetRecords&gt;
   &lt;record&gt;
     &lt;biblioitemnumber&gt;1&lt;/biblioitemnumber&gt;
     &lt;items&gt;
       &lt;item&gt;
         &lt;biblioitemnumber&gt;1&lt;/biblioitemnumber&gt;
-        &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
+        &lt;withdrawn&gt;0&lt;/withdrawn&gt;
         &lt;holdingbranchname&gt;Bibliothèque Jean Prunier&lt;/holdingbranchname&gt;
         &lt;notforloan&gt;0&lt;/notforloan&gt;
         &lt;replacementpricedate&gt;2008-08-20&lt;/replacementpricedate&gt;
     &lt;items&gt;
       &lt;item&gt;
         &lt;biblioitemnumber&gt;2&lt;/biblioitemnumber&gt;
-        &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
+        &lt;withdrawn&gt;0&lt;/withdrawn&gt;
         &lt;holdingbranchname&gt;Bibliothèque Jean Prunier&lt;/holdingbranchname&gt;
         &lt;notforloan&gt;0&lt;/notforloan&gt;
         &lt;replacementpricedate&gt;2008-08-20&lt;/replacementpricedate&gt;
                         </ul>
                     </dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999">
-                    ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=GetAuthorityRecords&amp;id=1+2+99999">
+                    ilsdi.pl?service=GetAuthorityRecords&amp;id=1+2+99999
                 </a>
-                <h4>Example Response</h4>
+                <h4>Example response</h4>
 <pre>&lt;xml version="1.0" encoding="UTF-8"&gt;;
 &lt;GetAuthorityRecords&gt;
   &lt;record&gt;
                         </ul>
                     </dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber">
-                    ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=LookupPatron&amp;id=815&amp;id_type=cardnumber">
+                    ilsdi.pl?service=LookupPatron&amp;id=815&amp;id_type=cardnumber
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;LookupPatron&gt;
   &lt;id&gt;419&lt;/id&gt;
 &lt;/LookupPatron&gt;</pre>
                 <h4>Parameters</h4>
                 <dl>
                     <dt><strong>username</strong> (Required)</dt>
-                    <dd>user's login identifier</dd>
+                    <dd>user's login identifier (userid or cardnumber)</dd>
                     <dt><strong>password</strong> (Required)</dt>
                     <dd>user's password</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul">
-                    ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=AuthenticatePatron&amp;username=john9&amp;password=soul">
+                    ilsdi.pl?service=AuthenticatePatron&amp;username=john9&amp;password=soul
                 </a>
                 <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;AuthenticatePatron&gt;
   &lt;id&gt;419&lt;/id&gt;
 &lt;/AuthenticatePatron&gt;</pre>
                     <dt><strong>show_loans</strong> (Optional, default 0)</dt>
                     <dd>whether or not to return loan information in the response</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1">
-                    ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=GetPatronInfo&amp;patron_id=1&amp;show_contact=0&amp;show_loans=1">
+                    ilsdi.pl?service=GetPatronInfo&amp;patron_id=1&amp;show_contact=0&amp;show_loans=1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;GetPatronInfo&gt;
   &lt;category_type&gt;A&lt;/category_type&gt;
   &lt;categorycode&gt;ADUEXT&lt;/categorycode&gt;
       &lt;dateaccessioned&gt;2008-08-23&lt;/dateaccessioned&gt;
       &lt;onloan&gt;2008-09-17&lt;/onloan&gt;
       &lt;biblioitemnumber&gt;4483&lt;/biblioitemnumber&gt;
-      &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
+      &lt;withdrawn&gt;0&lt;/withdrawn&gt;
       &lt;notforloan&gt;0&lt;/notforloan&gt;
       &lt;replacementpricedate&gt;2008-08-23&lt;/replacementpricedate&gt;
       &lt;itemcallnumber&gt;RO STE&lt;/itemcallnumber&gt;
       &lt;notes&gt;La couv. porte en plus : "un guide simple et facile pour apprendre la guitare" | Glossaire. Index&lt;/notes&gt;
       &lt;onloan&gt;2008-09-25&lt;/onloan&gt;
       &lt;biblioitemnumber&gt;4486&lt;/biblioitemnumber&gt;
-      &lt;wthdrawn&gt;0&lt;/wthdrawn&gt;
+      &lt;withdrawn&gt;0&lt;/withdrawn&gt;
       &lt;notforloan&gt;0&lt;/notforloan&gt;
       &lt;replacementpricedate&gt;2008-08-23&lt;/replacementpricedate&gt;
       &lt;itemcallnumber&gt;787.87 BUC&lt;/itemcallnumber&gt;
                     <dt><strong>patron_id</strong> (Required)</dt>
                     <dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetPatronStatus&patron_id=1">
-                    ilsdi.pl?service=GetPatronStatus&patron_id=1
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=GetPatronStatus&amp;patron_id=1">
+                    ilsdi.pl?service=GetPatronStatus&amp;patron_id=1
                 </a>
                 <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;GetPatronStatus&gt;
   &lt;expiry&gt;2010-03-04&lt;/expiry&gt;
   &lt;status&gt;0&lt;/status&gt;
                     <dt><strong>item_id</strong> (Required)</dt>
                     <dd>system item identifier</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=GetServices&patron_id=1&item_id=1">
-                    ilsdi.pl?service=GetServices&patron_id=1&item_id=1
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=GetServices&amp;patron_id=1&amp;item_id=1">
+                    ilsdi.pl?service=GetServices&amp;patron_id=1&amp;item_id=1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;GetServices&gt;
   &lt;AvailableFor&gt;title level hold&lt;/AvailableFor&gt;
   &lt;AvailableFor&gt;item level hold&lt;/AvailableFor&gt;
                     <dt><strong>desired_due_date</strong> (Required)</dt>
                     <dd>the date the patron would like the item returned by</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1">
-                    ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=RenewLoan&amp;patron_id=1&amp;item_id=1">
+                    ilsdi.pl?service=RenewLoan&amp;patron_id=1&amp;item_id=1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;RenewLoan&gt;
   &lt;success&gt;0&lt;/success&gt;
   &lt;renewals&gt;5&lt;/renewals&gt;
                     <dd>date after which item returned to shelf if item is not picked up</dd>
                 </dl>
                 <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1">
-                    ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1
+                <a href="ilsdi.pl?service=HoldTitle&amp;patron_id=1&amp;bib_id=1&amp;request_location=127.0.0.1">
+                    ilsdi.pl?service=HoldTitle&amp;patron_id=1&amp;bib_id=1&amp;request_location=127.0.0.1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;HoldTitle&gt;
   &lt;title&gt;(les) galères de l'Orfèvre&lt;/title&gt;
   &lt;date_available&gt;2009-05-11&lt;/date_available&gt;
                     <dd>date after which item returned to shelf if item is not picked up</dd>
                 </dl>
                 <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1">
-                    ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1
+                <a href="ilsdi.pl?service=HoldItem&amp;patron_id=1&amp;bib_id=1&amp;item_id=1">
+                    ilsdi.pl?service=HoldItem&amp;patron_id=1&amp;bib_id=1&amp;item_id=1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;HoldTitle&gt;
   &lt;title&gt;(les) galères de l'Orfèvre&lt;/title&gt;
   &lt;date_available&gt;2009-05-11&lt;/date_available&gt;
                     <dt><strong>item_id</strong> (Required)</dt>
                     <dd>system item identifier</dd>
                 </dl>
-                <h4>Example Call</h4>
-                <a href="ilsdi.pl?service=CancelHold&patron_id=1&item_id=1">
-                    ilsdi.pl?service=CancelHold&patron_id=1&item_id=1
+                <h4>Example call</h4>
+                <a href="ilsdi.pl?service=CancelHold&amp;patron_id=1&amp;item_id=1">
+                    ilsdi.pl?service=CancelHold&amp;patron_id=1&amp;item_id=1
                 </a>
-                <h4>Example Response</h4>
-<pre>&lt;?xml version="1.0" encoding="ISO-8859-1" ?&gt;
+                <h4>Example response</h4>
+<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
 &lt;CancelHold&gt;
   &lt;message&gt;Canceled&lt;/message&gt;
 &lt;/CancelHold&gt;</pre>
 
 [% ELSE %]
 
-                <h2>Level 1: Basic Discovery Interfaces</h2>
+                <h2>Level 1: Basic discovery interfaces</h2>
                 <ul>
                     <li>HarvestBibliographicRecords <em>(Use OAI-PMH instead)</em></li>
                     <li>HarvestExpandedRecords <em>(Use OAI-PMH instead)</em></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetAvailability">GetAvailability</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetAvailability">GetAvailability</a></li>
                     <li>GoToBibliographicRequestPage <em>(Use OPAC instead)</em></li>
                 </ul>
                 <h2>Level 2: Elementary OPAC supplement</h2>
                 <ul>
                     <li>HarvestAuthorityRecords <em>(Use OAI-PMH instead)</em></li>
                     <li>HarvestHoldingsRecords <em>(Use OAI-PMH instead)</em></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetRecords">GetRecords</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetRecords">GetRecords</a></li>
                     <li>Search <em>(Use SRU instead)</em></li>
                     <li>Scan <em>(Use SRU instead)</em></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetAuthorityRecords">GetAuthorityRecords</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetAuthorityRecords">GetAuthorityRecords</a></li>
                     <li>OutputRewritablePage <em>(Not supported yet)</em></li>
                     <li>OutputIntermediateFormat <em>(Not supported yet)</em></li>
                 </ul>
                 <h2>Level 3: Elementary OPAC alternative</h2>
                 <ul>
-                    <li><a href="ilsdi.pl?service=Describe&verb=LookupPatron">LookupPatron</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=AuthenticatePatron">AuthenticatePatron</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetPatronInfo">GetPatronInfo</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetPatronStatus">GetPatronStatus</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=GetServices">GetServices</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=RenewLoan">RenewLoan</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=HoldTitle">HoldTitle</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=HoldItem">HoldItem</a></li>
-                    <li><a href="ilsdi.pl?service=Describe&verb=CancelHold">CancelHold</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=LookupPatron">LookupPatron</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=AuthenticatePatron">AuthenticatePatron</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetPatronInfo">GetPatronInfo</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetPatronStatus">GetPatronStatus</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=GetServices">GetServices</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=RenewLoan">RenewLoan</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=HoldTitle">HoldTitle</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=HoldItem">HoldItem</a></li>
+                    <li><a href="ilsdi.pl?service=Describe&amp;verb=CancelHold">CancelHold</a></li>
                     <li>RecallItem <em>(Not supported by Koha)</em></li>
                     <li>CancelRecall <em>(Not supported by Koha)</em></li>
                 </ul>