[% INCLUDE 'masthead.inc' %]

ILS-DI

[% IF ( GetAvailability ) %]

GetAvailability

Given a set of bibliographic or item identifiers, returns a list with availability of the items associated with the identifiers.

Parameters

id (Required)

list of either bibliographic or item identifiers

id_type (Required)

defines the type of record identifier being used in the request, possible values:

bib
item

return_type (Optional)

requests a particular level of detail in reporting availability, possible values:

bib
item

return_fmt (Optional)

requests a particular format or set of formats in reporting availability

Example Call

ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item

Example Response

<?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>

[% ELSIF ( GetRecords ) %]

GetRecords

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.

You can use OAI-PMH ListRecords instead of this service.

Parameters

id (Required)

list of system record identifiers

id_type (Optional)

Defines the metadata schema in which the records are returned, possible values:

MARCXML

Example Call

ilsdi.pl?service=GetRecords&id=1+2+99999

Example Response

<?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>
        <wthdrawn>0</wthdrawn>
        <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>
        <wthdrawn>0</wthdrawn>
        <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>

[% ELSIF ( GetAuthorityRecords ) %]

GetAuthorityRecords

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.

Parameters

id (Required)

list of authority record identifiers

schema (Optional)

specifies the metadata schema of records to be returned, possible values:

MARCXML

Example Call

ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999

Example Response

<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>

[% ELSIF ( LookupPatron ) %]

LookupPatron

Looks up a patron in the ILS by an identifier, and returns the ILS identifier for that patron, aka the patron identifier.

Parameters

id (Required)

an identifier used to look up the patron in Koha

id_type (Optional)

the type of the identifier, possible values:

cardnumber
surname
borrowernumber

Example Call

ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<LookupPatron>
  <id>419</id>
</LookupPatron>

[% ELSIF ( AuthenticatePatron ) %]

AuthenticatePatron

Authenticates a user's login credentials and returns the identifier for the patron.

Parameters

username (Required): user's login identifier
password (Required): user's password

Example Call

ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<AuthenticatePatron>
  <id>419</id>
</AuthenticatePatron>

[% ELSIF ( GetPatronInfo ) %]

GetPatronInfo

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.

Parameters

patron_id (Required): the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron
show_contact (Optional, default 1): whether or not to return patron's contact information in the response
show_fines (Optional, default 0): whether or not to return fine information in the response
show_holds (Optional, default 0): whether or not to return hold request information in the response
show_loans (Optional, default 0): whether or not to return loan information in the response

Example Call

ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1

Example Response

<?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>
      <wthdrawn>0</wthdrawn>
      <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>
      <wthdrawn>0</wthdrawn>
      <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>

[% ELSIF ( GetPatronStatus ) %]

GetPatronStatus

Returns a patron's status information from Koha.

Parameters

patron_id (Required): the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron

Example Call

ilsdi.pl?service=GetPatronStatus&patron_id=1

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<GetPatronStatus>
  <expiry>2010-03-04</expiry>
  <status>0</status>
  <type>ADUEXT</type>
</GetPatronStatus>

[% ELSIF ( GetServices ) %]

GetServices

Returns information about the services available on a particular item for a particular patron.

Parameters

patron_id (Required): the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron
item_id (Required): system item identifier

Example Call

ilsdi.pl?service=GetServices&patron_id=1&item_id=1

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<GetServices>
  <AvailableFor>title level hold</AvailableFor>
  <AvailableFor>item level hold</AvailableFor>
</GetServices>

[% ELSIF ( RenewLoan ) %]

RenewLoan

Extends the due date for a patron's existing loan.

Parameters

patron_id (Required): the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron
item_id (Required): system item identifier
desired_due_date (Required): the date the patron would like the item returned by

Example Call

ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<RenewLoan>
  <success>0</success>
  <renewals>5</renewals>
  <date_due>2009-05-11</date_due>
</RenewLoan>

[% ELSIF ( HoldTitle ) %]

HoldTitle

Creates, for a patron, a title-level hold request on a given bibliographic record in Koha.

Parameters

patron_id (Required): the ILS identifier for the patron for whom the request is placed
bib_id (Required): the ILS identifier for the bibliographic record on which the request is placed
request_location (Required): IP address where the end user request is being placed
pickup_location (Optional): an identifier indicating the location to which to deliver the item for pickup
needed_before_date (Optional): date after which hold request is no longer needed
pickup_expiry_date (Optional): date after which item returned to shelf if item is not picked up

Example Call

ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1

Example Response

<?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>

[% ELSIF ( HoldItem ) %]

HoldItem

Creates, for a patron, an item-level hold request on a specific item of a bibliographic record Koha.

Parameters

patron_id (Required): the ILS identifier for the patron for whom the request is placed
bib_id (Required): the ILS identifier for the bibliographic record on which the request is placed
item_id (Required): the ILS identifier for the specific item on which the request is placed
pickup_location (Optional): an identifier indicating the location to which to deliver the item for pickup
needed_before_date (Optional): date after which hold request is no longer needed
pickup_expiry_date (Optional): date after which item returned to shelf if item is not picked up

Example Call

ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1

Example Response

<?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>

[% ELSIF ( CancelHold ) %]

CancelHold

Cancels an active hold request for the patron.

Parameters

patron_id (Required): the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron
item_id (Required): system item identifier

Example Call

ilsdi.pl?service=CancelHold&patron_id=1&item_id=1

Example Response

<?xml version="1.0" encoding="ISO-8859-1" ?>
<CancelHold>
  <message>Canceled</message>
</CancelHold>

[% ELSE %]

Level 1: Basic Discovery Interfaces

HarvestBibliographicRecords (Use OAI-PMH instead)
HarvestExpandedRecords (Use OAI-PMH instead)
GetAvailability
GoToBibliographicRequestPage (Use OPAC instead)

Level 2: Elementary OPAC supplement

HarvestAuthorityRecords (Use OAI-PMH instead)
HarvestHoldingsRecords (Use OAI-PMH instead)
GetRecords
Search (Use SRU instead)
Scan (Use SRU instead)
GetAuthorityRecords
OutputRewritablePage (Not supported yet)
OutputIntermediateFormat (Not supported yet)

Level 3: Elementary OPAC alternative

LookupPatron
AuthenticatePatron
GetPatronInfo
GetPatronStatus
GetServices
RenewLoan
HoldTitle
HoldItem
CancelHold
RecallItem (Not supported by Koha)
CancelRecall (Not supported by Koha)

Level 4: Robust/domain specific discovery platforms

SearchCourseReserves (Not supported yet)
Explain (Not supported yet)

[% END %]

[% IF ( OpacNav ) %]

[% INCLUDE 'navigation.inc' %]

[% END %]