65e541085c
Patch provides a constrained set of borrower attributes to try in turn if the ID type is not specified. Also added "email" to the POD documented list of id types seeing as its quite a useful one for integration developers. Test plan: 1) without the patch applied, turn on ils-di interface in your admin sysprefs and then try accessing the URL: https://your-server/cgi-bin/koha/ilsdi.pl?service=LookupPatron&id=Mabel replacing "your-server" your Koha dev test domain name (localhost:8080 if you're using a kohadevbox VM) and "Mabel" with the first name of a patron (Mabel is in the test database already if you're using that). You should get back an error message in the XML. 2) Apply the patch and repeat. This time you should get an <id> element in the XML with Mabel's patron ID in it. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
832 lines
44 KiB
Text
832 lines
44 KiB
Text
[% USE Koha %]
|
|
[% INCLUDE 'doc-head-open.inc' %]
|
|
<title>[% IF ( LibraryNameTitle ) %][% LibraryNameTitle %][% ELSE %]Koha online[% END %] catalog ›
|
|
[% IF ( GetAvailability ) %]
|
|
ILS-DI › GetAvailability
|
|
[% ELSIF ( GetRecords ) %]
|
|
ILS-DI › GetRecords
|
|
[% ELSIF ( GetAuthorityRecords ) %]
|
|
ILS-DI › GetAuthorityRecords
|
|
[% ELSIF ( LookupPatron ) %]
|
|
ILS-DI › LookupPatron
|
|
[% ELSIF ( AuthenticatePatron ) %]
|
|
ILS-DI › AuthenticatePatron
|
|
[% ELSIF ( GetPatronInfo ) %]
|
|
ILS-DI › GetPatronInfo
|
|
[% ELSIF ( GetPatronStatus ) %]
|
|
ILS-DI › GetPatronStatus
|
|
[% ELSIF ( GetServices ) %]
|
|
ILS-DI › GetServices
|
|
[% ELSIF ( RenewLoan ) %]
|
|
ILS-DI › RenewLoan
|
|
[% ELSIF ( HoldTitle ) %]
|
|
ILS-DI › HoldTitle
|
|
[% ELSIF ( HoldItem ) %]
|
|
ILS-DI › HoldItem
|
|
[% ELSIF ( CancelHold ) %]
|
|
ILS-DI › CancelHold
|
|
[% ELSE %]
|
|
ILS-DI
|
|
[% END %]</title>
|
|
[% INCLUDE 'doc-head-close.inc' %]
|
|
[% BLOCK cssinclude %][% END %]
|
|
</head>
|
|
<body id="opac_ilsdi" class="opac">
|
|
[% INCLUDE 'masthead.inc' %]
|
|
|
|
<div class="main">
|
|
<ul class="breadcrumb">
|
|
<li><a href="/cgi-bin/koha/opac-main.pl">Home</a> <span class="divider">›</span></li>
|
|
[% IF ( GetAvailability ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetAvailability</a></li>
|
|
[% ELSIF ( GetRecords ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetRecords</a></li>
|
|
[% ELSIF ( GetAuthorityRecords ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetAuthorityRecords</a></li>
|
|
[% ELSIF ( LookupPatron ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">LookupPatron</a></li>
|
|
[% ELSIF ( AuthenticatePatron ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">AuthenticatePatron</a></li>
|
|
[% ELSIF ( GetPatronInfo ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetPatronInfo</a></li>
|
|
[% ELSIF ( GetPatronStatus ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetPatronStatus</a></li>
|
|
[% ELSIF ( GetServices ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">GetServices</a></li>
|
|
[% ELSIF ( RenewLoan ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">RenewLoan</a></li>
|
|
[% ELSIF ( HoldTitle ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">HoldTitle</a></li>
|
|
[% ELSIF ( HoldItem ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">HoldItem</a></li>
|
|
[% ELSIF ( CancelHold ) %]
|
|
<li><a href="/cgi-bin/koha/ilsdi.pl">ILS-DI</a> <span class="divider">›</span></li>
|
|
<li><a href="#">CancelHold</a></li>
|
|
[% ELSE %]
|
|
<li><a href="#">ILS-DI</a></li>
|
|
[% END %]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
[% IF ( OpacNav || OpacNavBottom ) %]
|
|
<div class="span2">
|
|
<div id="navigation">
|
|
[% INCLUDE 'navigation.inc' %]
|
|
</div>
|
|
</div>
|
|
<div class="span10">
|
|
[% ELSE %]
|
|
<div class="span12">
|
|
[% END %]
|
|
<div id="ilsdi">
|
|
<h1>ILS-DI</h1>
|
|
[% IF ( GetAvailability ) %]
|
|
|
|
<h2>GetAvailability</h2>
|
|
<p>Given a set of bibliographic or item identifiers, returns a
|
|
list with availability of the items associated with the identifiers.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>id</strong> (Required)</dt>
|
|
<dd>list of either bibliographic or item identifiers</dd>
|
|
<dt><strong>id_type</strong> (Required)</dt>
|
|
<dd>defines the type of record identifier being used in the request, possible values:
|
|
<ul>
|
|
<li>bib</li>
|
|
<li>item</li>
|
|
</ul>
|
|
</dd>
|
|
<dt><strong>return_type</strong> (Optional)</dt>
|
|
<dd>requests a particular level of detail in reporting availability, possible values:
|
|
<ul>
|
|
<li>bib</li>
|
|
<li>item</li>
|
|
</ul>
|
|
</dd>
|
|
<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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<dlf:collection
|
|
xmlns:dlf="http://diglib.org/ilsdi/1.1"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://diglib.org/ilsdi/1.1
|
|
http://diglib.org/architectures/ilsdi/schemas/1.1/dlfexpanded.xsd">
|
|
<dlf:record>
|
|
<dlf:bibliographic id="1" />
|
|
<dlf:items>
|
|
<dlf:item id="1">
|
|
<dlf:simpleavailability>
|
|
<dlf:identifier>1</dlf:identifier>
|
|
<dlf:availabilitystatus>available</dlf:availabilitystatus>
|
|
<dlf:location>Bibliothèque Jean Prunier</dlf:location>
|
|
</dlf:simpleavailability>
|
|
</dlf:item>
|
|
</dlf:items>
|
|
</dlf:record>
|
|
<dlf:record>
|
|
<dlf:bibliographic id="2" />
|
|
<dlf:items>
|
|
<dlf:item id="2">
|
|
<dlf:simpleavailability>
|
|
<dlf:identifier>2</dlf:identifier>
|
|
<dlf:availabilitystatus>available</dlf:availabilitystatus>
|
|
<dlf:location>Bibliothèque Jean Prunier</dlf:location>
|
|
</dlf:simpleavailability>
|
|
</dlf:item>
|
|
</dlf:items>
|
|
</dlf:record>
|
|
<dlf:record>
|
|
<dlf:bibliographic id="99999" />
|
|
<dlf:items>
|
|
<dlf:item id="99999">
|
|
<dlf:simpleavailability>
|
|
<dlf:identifier>99999</dlf:identifier>
|
|
|
|
<dlf:availabilitystatus>unknown</dlf:availabilitystatus>
|
|
<dlf:availabilitymsg>Error: could not retrieve availability for this ID</dlf:availabilitymsg>
|
|
</dlf:simpleavailability>
|
|
</dlf:item>
|
|
</dlf:items>
|
|
</dlf:record>
|
|
</dlf:collection></pre>
|
|
|
|
[% ELSIF ( GetRecords ) %]
|
|
|
|
<h2>GetRecords</h2>
|
|
<p>Given a list of record identifiers, returns a list of record
|
|
objects that contain bibliographic information, as well as
|
|
associated holdings and item information. The caller may request
|
|
a specific metadata schema for the record objects to be returned.
|
|
This function behaves similarly to HarvestBibliographicRecords and
|
|
HarvestExpandedRecords in Data Aggregation, but allows quick, real
|
|
time lookup by bibliographic identifier.</p>
|
|
<p>You can use OAI-PMH ListRecords instead of this service.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>id</strong> (Required)</dt>
|
|
<dd>list of system record identifiers</dd>
|
|
<dt><strong>id_type</strong> (Optional)</dt>
|
|
<dd>Defines the metadata schema in which the records are
|
|
returned, possible values:
|
|
<ul>
|
|
<li>MARCXML</li>
|
|
</ul>
|
|
</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>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<GetRecords>
|
|
<record>
|
|
<biblioitemnumber>1</biblioitemnumber>
|
|
<isbn>9782862749198</isbn>
|
|
<marcxml>
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<record
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
|
|
xmlns="http://www.loc.gov/MARC21/slim">
|
|
<leader>00397nac a22001451u 4500</leader>
|
|
<datafield tag="010" ind1=" " ind2=" ">
|
|
<subfield code="a">9782862749198</subfield>
|
|
</datafield>
|
|
<datafield tag="090" ind1=" " ind2=" ">
|
|
<subfield code="a">1</subfield>
|
|
</datafield>
|
|
<datafield tag="101" ind1=" " ind2=" ">
|
|
<subfield code="a">fre</subfield>
|
|
</datafield>
|
|
<datafield tag="100" ind1=" " ind2=" ">
|
|
<subfield code="a">20080725 frey50 </subfield>
|
|
</datafield>
|
|
<datafield tag="200" ind1=" " ind2=" ">
|
|
<subfield code="a">Jardins d'enfance</subfield>
|
|
<subfield code="b">LITT</subfield>
|
|
<subfield code="f">Abécassis, Eliette</subfield>
|
|
</datafield>
|
|
<datafield tag="210" ind1=" " ind2=" ">
|
|
<subfield code="c">cherche midi éditeur</subfield>
|
|
<subfield code="d">11/2001</subfield>
|
|
</datafield>
|
|
<datafield tag="215" ind1=" " ind2=" ">
|
|
<subfield code="a">180</subfield>
|
|
</datafield>
|
|
<datafield tag="225" ind1=" " ind2=" ">
|
|
<subfield code="a">nouvelles</subfield>
|
|
</datafield>
|
|
<datafield tag="995" ind1=" " ind2=" ">
|
|
<subfield code="9">1</subfield>
|
|
<subfield code="c">BIB</subfield>
|
|
<subfield code="2">0</subfield>
|
|
<subfield code="k">R ABE</subfield>
|
|
<subfield code="o">0</subfield>
|
|
<subfield code="e">Secteur Adulte</subfield>
|
|
<subfield code="b">BIB</subfield>
|
|
<subfield code="j">7786000200</subfield>
|
|
<subfield code="q">a</subfield>
|
|
<subfield code="r">2</subfield>
|
|
<subfield code="s">Achats</subfield>
|
|
</datafield>
|
|
<controlfield tag="001">1</controlfield>
|
|
</record>
|
|
</marcxml>
|
|
<publicationyear>2001</publicationyear>
|
|
<collectiontitle>nouvelles</collectiontitle>
|
|
<pages>180</pages>
|
|
<issues>
|
|
</issues>
|
|
<itemtype>LITT</itemtype>
|
|
<biblionumber>1</biblionumber>
|
|
<timestamp>2008-09-03 18:43:19</timestamp>
|
|
<cn_sort>_</cn_sort>
|
|
<publishercode>cherche midi éditeur</publishercode>
|
|
<reserves>
|
|
</reserves>
|
|
<items>
|
|
<item>
|
|
<biblioitemnumber>1</biblioitemnumber>
|
|
<withdrawn>0</withdrawn>
|
|
<holdingbranchname>Bibliothèque Jean Prunier</holdingbranchname>
|
|
<notforloan>0</notforloan>
|
|
<replacementpricedate>2008-08-20</replacementpricedate>
|
|
<itemnumber>1</itemnumber>
|
|
<location>Secteur Adulte</location>
|
|
<itemcallnumber>R ABE</itemcallnumber>
|
|
<date_due></date_due>
|
|
<itemlost>0</itemlost>
|
|
<datelastseen>2008-08-20</datelastseen>
|
|
<homebranch>BIB</homebranch>
|
|
<homebranchname>Bibliothèque Jean Prunier</homebranchname>
|
|
<biblionumber>1</biblionumber>
|
|
<holdingbranch>BIB</holdingbranch>
|
|
<timestamp>2008-08-20 17:15:51</timestamp>
|
|
<damaged>0</damaged>
|
|
<cn_sort>R_ABE</cn_sort>
|
|
<dateaccessioned>2008-08-20</dateaccessioned>
|
|
</item>
|
|
</items>
|
|
</record>
|
|
<record>
|
|
<biblioitemnumber>2</biblioitemnumber>
|
|
<isbn>9782265078031</isbn>
|
|
<marcxml>
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<record
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
|
|
xmlns="http://www.loc.gov/MARC21/slim">
|
|
<leader>00407nac a22001451u 4500</leader>
|
|
<datafield tag="010" ind1=" " ind2=" ">
|
|
<subfield code="a">9782265078031</subfield>
|
|
</datafield>
|
|
<datafield tag="090" ind1=" " ind2=" ">
|
|
<subfield code="a">2</subfield>
|
|
</datafield>
|
|
<datafield tag="101" ind1=" " ind2=" ">
|
|
<subfield code="a">fre</subfield>
|
|
</datafield>
|
|
<datafield tag="100" ind1=" " ind2=" ">
|
|
<subfield code="a">20080725 frey50 </subfield>
|
|
</datafield>
|
|
<datafield tag="200" ind1=" " ind2=" ">
|
|
<subfield code="a">(Les) tribulations d'une jeune divorcée</subfield>
|
|
<subfield code="b">LITT</subfield>
|
|
<subfield code="f">Abécassis, Eliette</subfield>
|
|
</datafield>
|
|
<datafield tag="210" ind1=" " ind2=" ">
|
|
<subfield code="c">bussière</subfield>
|
|
<subfield code="d">01/2005</subfield>
|
|
</datafield>
|
|
<datafield tag="215" ind1=" " ind2=" ">
|
|
<subfield code="a">306</subfield>
|
|
</datafield>
|
|
<datafield tag="225" ind1=" " ind2=" ">
|
|
<subfield code="a">fleuve noir</subfield>
|
|
</datafield>
|
|
<datafield tag="995" ind1=" " ind2=" ">
|
|
<subfield code="9">2</subfield>
|
|
<subfield code="c">BIB</subfield>
|
|
<subfield code="2">0</subfield>
|
|
<subfield code="k">R ABE</subfield>
|
|
<subfield code="o">0</subfield>
|
|
<subfield code="e">Secteur Adulte</subfield>
|
|
<subfield code="b">BIB</subfield>
|
|
<subfield code="j">7786004672</subfield>
|
|
<subfield code="q">a</subfield>
|
|
<subfield code="s">Achats</subfield>
|
|
</datafield>
|
|
<controlfield tag="001">2</controlfield>
|
|
</record>
|
|
</marcxml>
|
|
<publicationyear>2005</publicationyear>
|
|
<collectiontitle>fleuve noir</collectiontitle>
|
|
<pages>306</pages>
|
|
<issues>
|
|
</issues>
|
|
<itemtype>LITT</itemtype>
|
|
<biblionumber>2</biblionumber>
|
|
<timestamp>2008-09-03 18:43:19</timestamp>
|
|
<cn_sort>_</cn_sort>
|
|
<publishercode>bussière</publishercode>
|
|
<reserves>
|
|
</reserves>
|
|
<items>
|
|
<item>
|
|
<biblioitemnumber>2</biblioitemnumber>
|
|
<withdrawn>0</withdrawn>
|
|
<holdingbranchname>Bibliothèque Jean Prunier</holdingbranchname>
|
|
<notforloan>0</notforloan>
|
|
<replacementpricedate>2008-08-20</replacementpricedate>
|
|
<itemnumber>2</itemnumber>
|
|
<location>Secteur Adulte</location>
|
|
<itemcallnumber>R ABE</itemcallnumber>
|
|
<date_due></date_due>
|
|
<itemlost>0</itemlost>
|
|
<datelastseen>2008-08-20</datelastseen>
|
|
<homebranch>BIB</homebranch>
|
|
<homebranchname>Bibliothèque Jean Prunier</homebranchname>
|
|
<biblionumber>2</biblionumber>
|
|
<holdingbranch>BIB</holdingbranch>
|
|
<timestamp>2008-08-20 17:15:51</timestamp>
|
|
<damaged>0</damaged>
|
|
<cn_sort>R_ABE</cn_sort>
|
|
<dateaccessioned>2008-08-20</dateaccessioned>
|
|
</item>
|
|
</items>
|
|
</record>
|
|
<record>RecordNotFound</record>
|
|
</GetRecords></pre>
|
|
|
|
[% ELSIF ( GetAuthorityRecords ) %]
|
|
|
|
<h2>GetAuthorityRecords</h2>
|
|
<p>Given a list of authority record identifiers, returns a list
|
|
of record objects that contain the authority records. The function
|
|
user may request a specific metadata schema for the record objects.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>id</strong> (Required)</dt>
|
|
<dd>list of authority record identifiers</dd>
|
|
<dt><strong>schema</strong> (Optional)</dt>
|
|
<dd>specifies the metadata schema of records to be returned, possible values:
|
|
<ul>
|
|
<li>MARCXML</li>
|
|
</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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><xml version="1.0" encoding="UTF-8">;
|
|
<GetAuthorityRecords>
|
|
<record>
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<record
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd"
|
|
xmlns="http://www.loc.gov/MARC21/slim">
|
|
<leader>00182 2200085 4500</leader>
|
|
<controlfield tag="001">1</controlfield>
|
|
<datafield tag="200" ind1=" " ind2=" ">
|
|
<subfield code="a">Hugo</subfield>
|
|
<subfield code="b">Victor</subfield>
|
|
</datafield>
|
|
<datafield tag="801" ind1=" " ind2=" ">
|
|
<subfield code="a">France</subfield>
|
|
<subfield code="b">Nimes</subfield>
|
|
<subfield code="c">2010/04/13</subfield>
|
|
</datafield>
|
|
<datafield tag="100" ind1=" " ind2=" ">
|
|
<subfield code="a">20100413 50 </subfield>
|
|
</datafield>
|
|
<datafield tag="152" ind1=" " ind2=" ">
|
|
<subfield code="b">NP</subfield>
|
|
</datafield>
|
|
</record>
|
|
</record>
|
|
<record>
|
|
<code>RecordNotFound</code>
|
|
</record>
|
|
<record>
|
|
<code>RecordNotFound</code>
|
|
</record>
|
|
</GetAuthorityRecords></pre>
|
|
|
|
[% ELSIF ( LookupPatron ) %]
|
|
|
|
<h2>LookupPatron</h2>
|
|
<p>Looks up a patron in the ILS by an identifier, and returns
|
|
the ILS identifier for that patron, aka the patron identifier.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>id</strong> (Required)</dt>
|
|
<dd>an identifier used to look up the patron in Koha</dd>
|
|
<dt><strong>id_type</strong> (Optional)</dt>
|
|
<dd>the type of the identifier, possible values:
|
|
<ul>
|
|
<li>cardnumber</li>
|
|
<li>userid</li>
|
|
<li>email</li>
|
|
<li>borrowernumber</li>
|
|
<li>surname</li>
|
|
<li>firstname</li>
|
|
</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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<LookupPatron>
|
|
<id>419</id>
|
|
</LookupPatron></pre>
|
|
|
|
[% ELSIF ( AuthenticatePatron ) %]
|
|
|
|
<h2>AuthenticatePatron</h2>
|
|
<p>Authenticates a user's login credentials and returns the identifier for the patron.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>username</strong> (Required)</dt>
|
|
<dd>user's login identifier</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
|
|
</a>
|
|
<h4>Example Response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<AuthenticatePatron>
|
|
<id>419</id>
|
|
</AuthenticatePatron></pre>
|
|
|
|
[% ELSIF ( GetPatronInfo ) %]
|
|
|
|
<h2>GetPatronInfo</h2>
|
|
<p>Returns specified information about the patron, based on
|
|
options in the request. This function can optionally return
|
|
patron's contact information, fine information, hold request
|
|
information, loan information, and messages.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
|
|
<dt><strong>show_contact</strong> (Optional, default 1)</dt>
|
|
<dd>whether or not to return patron's contact information in the response</dd>
|
|
<dt><strong>show_fines</strong> (Optional, default 0)</dt>
|
|
<dd>whether or not to return fine information in the response</dd>
|
|
<dt><strong>show_holds</strong> (Optional, default 0)</dt>
|
|
<dd>whether or not to return hold request information in the response</dd>
|
|
<dt><strong>show_loans</strong> (Optional, default 0)</dt>
|
|
<dd>whether or not to return loan information in the response</dd>
|
|
<dt><strong>show_attributes</strong> (Optional, default 0)</dt>
|
|
<dd>whether or not to return extended patron attributes 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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<GetPatronInfo>
|
|
<category_type>A</category_type>
|
|
<categorycode>ADUEXT</categorycode>
|
|
<borrowernumber>419</borrowernumber>
|
|
<lost>0</lost>
|
|
<branchcode>BIB</branchcode>
|
|
<amountoutstanding>6</amountoutstanding>
|
|
<description>Adulte extérieur</description>
|
|
<title>M</title>
|
|
<enrolmentperiod>12</enrolmentperiod>
|
|
<charges>6.00</charges>
|
|
<dateenrolled>2009-03-04</dateenrolled>
|
|
<borrowernotes></borrowernotes>
|
|
<dateexpiry>2010-03-04</dateexpiry>
|
|
<firstname>Jean-André</firstname>
|
|
<gonenoaddress>0</gonenoaddress>
|
|
<dateofbirth>1984-06-08</dateofbirth>
|
|
<debarred>0</debarred>
|
|
<branchname>Bibliothèque Jean Prunier</branchname>
|
|
<surname>SANTONI</surname>
|
|
<cardnumber>815</cardnumber>
|
|
<initials>JAS</initials>
|
|
<sort1>CSP5</sort1>
|
|
<sex>M</sex>
|
|
<loans>
|
|
<loan>
|
|
<lastreneweddate>2009-04-03</lastreneweddate>
|
|
<isbn>2253003689</isbn>
|
|
<borrowernumber>419</borrowernumber>
|
|
<branchcode>BIB</branchcode>
|
|
<itemnumber>4454</itemnumber>
|
|
<date_due>2009-05-06</date_due>
|
|
<barcode>4765476</barcode>
|
|
<datelastseen>2008-08-23</datelastseen>
|
|
<issuedate>2008-08-23</issuedate>
|
|
<title>L'Île au trésor</title>
|
|
<itemtype>LITT</itemtype>
|
|
<author>Robert Louis Stevenson</author>
|
|
<timestamp>2009-04-03 14:46:10</timestamp>
|
|
<publishercode>Librairie générale française</publishercode>
|
|
<datecreated>2008-08-23</datecreated>
|
|
<totalrenewals>11</totalrenewals>
|
|
<dateaccessioned>2008-08-23</dateaccessioned>
|
|
<onloan>2008-09-17</onloan>
|
|
<biblioitemnumber>4483</biblioitemnumber>
|
|
<withdrawn>0</withdrawn>
|
|
<notforloan>0</notforloan>
|
|
<replacementpricedate>2008-08-23</replacementpricedate>
|
|
<itemcallnumber>RO STE</itemcallnumber>
|
|
<location>Salle de lecture</location>
|
|
<itemlost>0</itemlost>
|
|
<publicationyear>1985</publicationyear>
|
|
<issues>1</issues>
|
|
<homebranch>BIB</homebranch>
|
|
<holdingbranch>BIB</holdingbranch>
|
|
<biblionumber>4483</biblionumber>
|
|
<renewals>3</renewals>
|
|
<damaged>0</damaged>
|
|
<cn_sort>RO_STE</cn_sort>
|
|
<frameworkcode></frameworkcode>
|
|
<datelastborrowed>2008-08-23</datelastborrowed>
|
|
</loan>
|
|
<loan>
|
|
<lastreneweddate>2009-03-17</lastreneweddate>
|
|
<isbn>9782700017823</isbn>
|
|
<borrowernumber>419</borrowernumber>
|
|
<branchcode>BIB</branchcode>
|
|
<itemnumber>4456</itemnumber>
|
|
<date_due>2009-04-18</date_due>
|
|
<barcode>2700017UUU</barcode>
|
|
<datelastseen>2008-08-23</datelastseen>
|
|
<issuedate>2008-08-23</issuedate>
|
|
<title>La guitare en 10 leçons</title>
|
|
<itemtype>LITT</itemtype>
|
|
<author>Jon Buck</author>
|
|
<timestamp>2009-03-17 16:48:14</timestamp>
|
|
<publishercode>Gründ</publishercode>
|
|
<datecreated>2008-08-23</datecreated>
|
|
<totalrenewals>6</totalrenewals>
|
|
<dateaccessioned>2008-08-23</dateaccessioned>
|
|
<notes>La couv. porte en plus : "un guide simple et facile pour apprendre la guitare" | Glossaire. Index</notes>
|
|
<onloan>2008-09-25</onloan>
|
|
<biblioitemnumber>4486</biblioitemnumber>
|
|
<withdrawn>0</withdrawn>
|
|
<notforloan>0</notforloan>
|
|
<replacementpricedate>2008-08-23</replacementpricedate>
|
|
<itemcallnumber>787.87 BUC</itemcallnumber>
|
|
<location>Salle de lecture</location>
|
|
<itemlost>0</itemlost>
|
|
<publicationyear>2007</publicationyear>
|
|
<issues>1</issues>
|
|
<homebranch>BIB</homebranch>
|
|
<holdingbranch>BIB</holdingbranch>
|
|
<biblionumber>4486</biblionumber>
|
|
<renewals>3</renewals>
|
|
<damaged>0</damaged>
|
|
<cn_sort>78787_BUC</cn_sort>
|
|
<volume>une méthode simple et facile pour apprendre la guitare</volume>
|
|
<frameworkcode></frameworkcode>
|
|
<datelastborrowed>2008-08-23</datelastborrowed>
|
|
</loan>
|
|
</loans>
|
|
</GetPatronInfo></pre>
|
|
|
|
[% ELSIF ( GetPatronStatus ) %]
|
|
|
|
<h2>GetPatronStatus</h2>
|
|
<p>Returns a patron's status information from Koha.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<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
|
|
</a>
|
|
<h4>Example Response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<GetPatronStatus>
|
|
<expiry>2010-03-04</expiry>
|
|
<status>0</status>
|
|
<type>ADUEXT</type>
|
|
</GetPatronStatus></pre>
|
|
|
|
[% ELSIF ( GetServices ) %]
|
|
|
|
<h2>GetServices</h2>
|
|
<p>Returns information about the services available on a particular item for a particular patron.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
|
|
<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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<GetServices>
|
|
<AvailableFor>title level hold</AvailableFor>
|
|
<AvailableFor>item level hold</AvailableFor>
|
|
</GetServices></pre>
|
|
|
|
[% ELSIF ( RenewLoan ) %]
|
|
|
|
<h2>RenewLoan</h2>
|
|
<p>Extends the due date for a patron's existing loan.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
|
|
<dt><strong>item_id</strong> (Required)</dt>
|
|
<dd>system item identifier</dd>
|
|
<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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<RenewLoan>
|
|
<success>0</success>
|
|
<renewals>5</renewals>
|
|
<date_due>2009-05-11</date_due>
|
|
</RenewLoan></pre>
|
|
|
|
[% ELSIF ( HoldTitle ) %]
|
|
|
|
<h2>HoldTitle</h2>
|
|
<p>Creates, for a patron, a title-level hold request on a given bibliographic record in Koha.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the ILS identifier for the patron for whom the request is placed</dd>
|
|
<dt><strong>bib_id</strong> (Required)</dt>
|
|
<dd>the ILS identifier for the bibliographic record on which the request is placed</dd>
|
|
<dt><strong>request_location</strong> (Required)</dt>
|
|
<dd>IP address where the end user request is being placed</dd>
|
|
<dt><strong>pickup_location</strong> (Optional)</dt>
|
|
<dd>an identifier indicating the location to which to deliver the item for pickup</dd>
|
|
<dt><strong>needed_before_date</strong> (Optional)</dt>
|
|
<dd>date after which hold request is no longer needed</dd>
|
|
<dt><strong>pickup_expiry_date</strong> (Optional)</dt>
|
|
<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>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<HoldTitle>
|
|
<title>(les) galères de l'Orfèvre</title>
|
|
<date_available>2009-05-11</date_available>
|
|
<pickup_location>Bibliothèque Jean-Prunier</pickup_location>
|
|
</HoldTitle></pre>
|
|
|
|
[% ELSIF ( HoldItem ) %]
|
|
|
|
<h2>HoldItem</h2>
|
|
<p>Creates, for a patron, an item-level hold request on a specific item of a bibliographic record Koha.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the ILS identifier for the patron for whom the request is placed</dd>
|
|
<dt><strong>bib_id</strong> (Required)</dt>
|
|
<dd>the ILS identifier for the bibliographic record on which the request is placed</dd>
|
|
<dt><strong>item_id</strong> (Required)</dt>
|
|
<dd>the ILS identifier for the specific item on which the request is placed</dd>
|
|
<dt><strong>pickup_location</strong> (Optional)</dt>
|
|
<dd>an identifier indicating the location to which to deliver the item for pickup</dd>
|
|
<dt><strong>needed_before_date</strong> (Optional)</dt>
|
|
<dd>date after which hold request is no longer needed</dd>
|
|
<dt><strong>pickup_expiry_date</strong> (Optional)</dt>
|
|
<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>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<HoldTitle>
|
|
<title>(les) galères de l'Orfèvre</title>
|
|
<date_available>2009-05-11</date_available>
|
|
<pickup_location>Bibliothèque Jean-Prunier</pickup_location>
|
|
</HoldTitle></pre>
|
|
|
|
[% ELSIF ( CancelHold ) %]
|
|
|
|
<h2>CancelHold</h2>
|
|
<p>Cancels an active hold request for the patron.</p>
|
|
<h4>Parameters</h4>
|
|
<dl>
|
|
<dt><strong>patron_id</strong> (Required)</dt>
|
|
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd>
|
|
<dt><strong>item_id</strong> (Required)</dt>
|
|
<dd>system hold identifier (returned by GetRecords and GetPatronInfo into element 'reserve_id')</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
|
|
</a>
|
|
<h4>Example response</h4>
|
|
<pre><?xml version="1.0" encoding="ISO-8859-1" ?>
|
|
<CancelHold>
|
|
<message>Canceled</message>
|
|
</CancelHold></pre>
|
|
|
|
[% ELSE %]
|
|
|
|
<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>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>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>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>RecallItem <em>(Not supported by Koha)</em></li>
|
|
<li>CancelRecall <em>(Not supported by Koha)</em></li>
|
|
</ul>
|
|
<h2>Level 4: Robust/domain specific discovery platforms</h2>
|
|
<ul>
|
|
<li>SearchCourseReserves <em>(Not supported yet)</em></li>
|
|
<li>Explain <em>(Not supported yet)</em></li>
|
|
</ul>
|
|
|
|
[% END # / IF GetAvailability %]
|
|
</div> <!-- / #ilsdi -->
|
|
</div> <!-- / .span10 -->
|
|
</div> <!-- / .row-fluid -->
|
|
</div> <!-- / .container-fluid -->
|
|
</div> <!-- / .main -->
|
|
|
|
[% INCLUDE 'opac-bottom.inc' %]
|
|
[% BLOCK jsinclude %][% END %]
|