|
Lines 100-106
Link Here
|
| 100 |
<p>Given a set of bibliographic or item identifiers, returns a |
100 |
<p>Given a set of bibliographic or item identifiers, returns a |
| 101 |
list with availability of the items associated with the identifiers.</p> |
101 |
list with availability of the items associated with the identifiers.</p> |
| 102 |
|
102 |
|
| 103 |
<h4>Parameters</h4> |
103 |
<h3>Parameters</h3> |
| 104 |
<dl> |
104 |
<dl> |
| 105 |
<dt><strong>id</strong> (Required)</dt> |
105 |
<dt><strong>id</strong> (Required)</dt> |
| 106 |
<dd>list of either bibliographic or item identifiers</dd> |
106 |
<dd>list of either bibliographic or item identifiers</dd> |
|
Lines 122-133
Link Here
|
| 122 |
<dd>requests a particular format or set of formats in reporting availability</dd> |
122 |
<dd>requests a particular format or set of formats in reporting availability</dd> |
| 123 |
</dl> |
123 |
</dl> |
| 124 |
|
124 |
|
| 125 |
<h4>Example call</h4> |
125 |
<h3>Example call</h3> |
| 126 |
<a href="ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item"> |
126 |
<a href="ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item"> |
| 127 |
ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item |
127 |
ilsdi.pl?service=GetAvailability&id=1+2+99999&id_type=item |
| 128 |
</a> |
128 |
</a> |
| 129 |
|
129 |
|
| 130 |
<h4>Example response</h4> |
130 |
<h3>Example response</h3> |
| 131 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
131 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 132 |
<dlf:collection |
132 |
<dlf:collection |
| 133 |
xmlns:dlf="http://diglib.org/ilsdi/1.1" |
133 |
xmlns:dlf="http://diglib.org/ilsdi/1.1" |
|
Lines 185-191
Link Here
|
| 185 |
time lookup by bibliographic identifier.</p> |
185 |
time lookup by bibliographic identifier.</p> |
| 186 |
<p>You can use OAI-PMH ListRecords instead of this service.</p> |
186 |
<p>You can use OAI-PMH ListRecords instead of this service.</p> |
| 187 |
|
187 |
|
| 188 |
<h4>Parameters</h4> |
188 |
<h3>Parameters</h3> |
| 189 |
<dl> |
189 |
<dl> |
| 190 |
<dt><strong>id</strong> (Required)</dt> |
190 |
<dt><strong>id</strong> (Required)</dt> |
| 191 |
<dd>list of system record identifiers</dd> |
191 |
<dd>list of system record identifiers</dd> |
|
Lines 198-209
Link Here
|
| 198 |
</dd> |
198 |
</dd> |
| 199 |
</dl> |
199 |
</dl> |
| 200 |
|
200 |
|
| 201 |
<h4>Example Call</h4> |
201 |
<h3>Example Call</h3> |
| 202 |
<a href="ilsdi.pl?service=GetRecords&id=1+2+99999"> |
202 |
<a href="ilsdi.pl?service=GetRecords&id=1+2+99999"> |
| 203 |
ilsdi.pl?service=GetRecords&id=1+2+99999 |
203 |
ilsdi.pl?service=GetRecords&id=1+2+99999 |
| 204 |
</a> |
204 |
</a> |
| 205 |
|
205 |
|
| 206 |
<h4>Example response</h4> |
206 |
<h3>Example response</h3> |
| 207 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
207 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 208 |
<GetRecords> |
208 |
<GetRecords> |
| 209 |
<record> |
209 |
<record> |
|
Lines 400-406
Link Here
|
| 400 |
of record objects that contain the authority records. The function |
400 |
of record objects that contain the authority records. The function |
| 401 |
user may request a specific metadata schema for the record objects.</p> |
401 |
user may request a specific metadata schema for the record objects.</p> |
| 402 |
|
402 |
|
| 403 |
<h4>Parameters</h4> |
403 |
<h3>Parameters</h3> |
| 404 |
<dl> |
404 |
<dl> |
| 405 |
<dt><strong>id</strong> (Required)</dt> |
405 |
<dt><strong>id</strong> (Required)</dt> |
| 406 |
<dd>list of authority record identifiers</dd> |
406 |
<dd>list of authority record identifiers</dd> |
|
Lines 412-423
Link Here
|
| 412 |
</dd> |
412 |
</dd> |
| 413 |
</dl> |
413 |
</dl> |
| 414 |
|
414 |
|
| 415 |
<h4>Example call</h4> |
415 |
<h3>Example call</h3> |
| 416 |
<a href="ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999"> |
416 |
<a href="ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999"> |
| 417 |
ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999 |
417 |
ilsdi.pl?service=GetAuthorityRecords&id=1+2+99999 |
| 418 |
</a> |
418 |
</a> |
| 419 |
|
419 |
|
| 420 |
<h4>Example response</h4> |
420 |
<h3>Example response</h3> |
| 421 |
<pre><xml version="1.0" encoding="UTF-8">; |
421 |
<pre><xml version="1.0" encoding="UTF-8">; |
| 422 |
<GetAuthorityRecords> |
422 |
<GetAuthorityRecords> |
| 423 |
<record> |
423 |
<record> |
|
Lines 459-465
Link Here
|
| 459 |
<p>Looks up a patron in the ILS by an identifier, and returns |
459 |
<p>Looks up a patron in the ILS by an identifier, and returns |
| 460 |
the ILS identifier for that patron, aka the patron identifier.</p> |
460 |
the ILS identifier for that patron, aka the patron identifier.</p> |
| 461 |
|
461 |
|
| 462 |
<h4>Parameters</h4> |
462 |
<h3>Parameters</h3> |
| 463 |
<dl> |
463 |
<dl> |
| 464 |
<dt><strong>id</strong> (Required)</dt> |
464 |
<dt><strong>id</strong> (Required)</dt> |
| 465 |
<dd>an identifier used to look up the patron in Koha</dd> |
465 |
<dd>an identifier used to look up the patron in Koha</dd> |
|
Lines 476-487
Link Here
|
| 476 |
</dd> |
476 |
</dd> |
| 477 |
</dl> |
477 |
</dl> |
| 478 |
|
478 |
|
| 479 |
<h4>Example call</h4> |
479 |
<h3>Example call</h3> |
| 480 |
<a href="ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber"> |
480 |
<a href="ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber"> |
| 481 |
ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber |
481 |
ilsdi.pl?service=LookupPatron&id=815&id_type=cardnumber |
| 482 |
</a> |
482 |
</a> |
| 483 |
|
483 |
|
| 484 |
<h4>Example response</h4> |
484 |
<h3>Example response</h3> |
| 485 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
485 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 486 |
<LookupPatron> |
486 |
<LookupPatron> |
| 487 |
<id>419</id> |
487 |
<id>419</id> |
|
Lines 492-510
Link Here
|
| 492 |
<h2>AuthenticatePatron</h2> |
492 |
<h2>AuthenticatePatron</h2> |
| 493 |
<p>Authenticates a user's login credentials and returns the identifier for the patron.</p> |
493 |
<p>Authenticates a user's login credentials and returns the identifier for the patron.</p> |
| 494 |
|
494 |
|
| 495 |
<h4>Parameters</h4> |
495 |
<h3>Parameters</h3> |
| 496 |
<dl> |
496 |
<dl> |
| 497 |
<dt><strong>username</strong> (Required)</dt> |
497 |
<dt><strong>username</strong> (Required)</dt> |
| 498 |
<dd>user's login identifier</dd> |
498 |
<dd>user's login identifier</dd> |
| 499 |
<dt><strong>password</strong> (Required)</dt> |
499 |
<dt><strong>password</strong> (Required)</dt> |
| 500 |
<dd>user's password</dd> |
500 |
<dd>user's password</dd> |
| 501 |
</dl> |
501 |
</dl> |
| 502 |
<h4>Example call</h4> |
502 |
<h3>Example call</h3> |
| 503 |
<a href="ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul"> |
503 |
<a href="ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul"> |
| 504 |
ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul |
504 |
ilsdi.pl?service=AuthenticatePatron&username=john9&password=soul |
| 505 |
</a> |
505 |
</a> |
| 506 |
|
506 |
|
| 507 |
<h4>Example Response</h4> |
507 |
<h3>Example Response</h3> |
| 508 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
508 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 509 |
<AuthenticatePatron> |
509 |
<AuthenticatePatron> |
| 510 |
<id>419</id> |
510 |
<id>419</id> |
|
Lines 518-524
Link Here
|
| 518 |
patron's contact information, fine information, hold request |
518 |
patron's contact information, fine information, hold request |
| 519 |
information, loan information, and messages.</p> |
519 |
information, loan information, and messages.</p> |
| 520 |
|
520 |
|
| 521 |
<h4>Parameters</h4> |
521 |
<h3>Parameters</h3> |
| 522 |
<dl> |
522 |
<dl> |
| 523 |
<dt><strong>patron_id</strong> (Required)</dt> |
523 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 524 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
524 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
|
Lines 534-545
Link Here
|
| 534 |
<dd>whether or not to return extended patron attributes information in the response</dd> |
534 |
<dd>whether or not to return extended patron attributes information in the response</dd> |
| 535 |
</dl> |
535 |
</dl> |
| 536 |
|
536 |
|
| 537 |
<h4>Example call</h4> |
537 |
<h3>Example call</h3> |
| 538 |
<a href="ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1"> |
538 |
<a href="ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1"> |
| 539 |
ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1 |
539 |
ilsdi.pl?service=GetPatronInfo&patron_id=1&show_contact=0&show_loans=1 |
| 540 |
</a> |
540 |
</a> |
| 541 |
|
541 |
|
| 542 |
<h4>Example response</h4> |
542 |
<h3>Example response</h3> |
| 543 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
543 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 544 |
<GetPatronInfo> |
544 |
<GetPatronInfo> |
| 545 |
<category_type>A</category_type> |
545 |
<category_type>A</category_type> |
|
Lines 651-668
Link Here
|
| 651 |
<h2>GetPatronStatus</h2> |
651 |
<h2>GetPatronStatus</h2> |
| 652 |
<p>Returns a patron's status information from Koha.</p> |
652 |
<p>Returns a patron's status information from Koha.</p> |
| 653 |
|
653 |
|
| 654 |
<h4>Parameters</h4> |
654 |
<h3>Parameters</h3> |
| 655 |
<dl> |
655 |
<dl> |
| 656 |
<dt><strong>patron_id</strong> (Required)</dt> |
656 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 657 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
657 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
| 658 |
</dl> |
658 |
</dl> |
| 659 |
|
659 |
|
| 660 |
<h4>Example call</h4> |
660 |
<h3>Example call</h3> |
| 661 |
<a href="ilsdi.pl?service=GetPatronStatus&patron_id=1"> |
661 |
<a href="ilsdi.pl?service=GetPatronStatus&patron_id=1"> |
| 662 |
ilsdi.pl?service=GetPatronStatus&patron_id=1 |
662 |
ilsdi.pl?service=GetPatronStatus&patron_id=1 |
| 663 |
</a> |
663 |
</a> |
| 664 |
|
664 |
|
| 665 |
<h4>Example Response</h4> |
665 |
<h3>Example Response</h3> |
| 666 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
666 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 667 |
<GetPatronStatus> |
667 |
<GetPatronStatus> |
| 668 |
<expiry>2010-03-04</expiry> |
668 |
<expiry>2010-03-04</expiry> |
|
Lines 675-681
Link Here
|
| 675 |
<h2>GetServices</h2> |
675 |
<h2>GetServices</h2> |
| 676 |
<p>Returns information about the services available on a particular item for a particular patron.</p> |
676 |
<p>Returns information about the services available on a particular item for a particular patron.</p> |
| 677 |
|
677 |
|
| 678 |
<h4>Parameters</h4> |
678 |
<h3>Parameters</h3> |
| 679 |
<dl> |
679 |
<dl> |
| 680 |
<dt><strong>patron_id</strong> (Required)</dt> |
680 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 681 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
681 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
|
Lines 683-694
Link Here
|
| 683 |
<dd>system item identifier</dd> |
683 |
<dd>system item identifier</dd> |
| 684 |
</dl> |
684 |
</dl> |
| 685 |
|
685 |
|
| 686 |
<h4>Example call</h4> |
686 |
<h3>Example call</h3> |
| 687 |
<a href="ilsdi.pl?service=GetServices&patron_id=1&item_id=1"> |
687 |
<a href="ilsdi.pl?service=GetServices&patron_id=1&item_id=1"> |
| 688 |
ilsdi.pl?service=GetServices&patron_id=1&item_id=1 |
688 |
ilsdi.pl?service=GetServices&patron_id=1&item_id=1 |
| 689 |
</a> |
689 |
</a> |
| 690 |
|
690 |
|
| 691 |
<h4>Example response</h4> |
691 |
<h3>Example response</h3> |
| 692 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
692 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 693 |
<GetServices> |
693 |
<GetServices> |
| 694 |
<AvailableFor>title level hold</AvailableFor> |
694 |
<AvailableFor>title level hold</AvailableFor> |
|
Lines 700-706
Link Here
|
| 700 |
<h2>RenewLoan</h2> |
700 |
<h2>RenewLoan</h2> |
| 701 |
<p>Extends the due date for a patron's existing loan.</p> |
701 |
<p>Extends the due date for a patron's existing loan.</p> |
| 702 |
|
702 |
|
| 703 |
<h4>Parameters</h4> |
703 |
<h3>Parameters</h3> |
| 704 |
<dl> |
704 |
<dl> |
| 705 |
<dt><strong>patron_id</strong> (Required)</dt> |
705 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 706 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
706 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
|
Lines 710-721
Link Here
|
| 710 |
<dd>the date the patron would like the item returned by</dd> |
710 |
<dd>the date the patron would like the item returned by</dd> |
| 711 |
</dl> |
711 |
</dl> |
| 712 |
|
712 |
|
| 713 |
<h4>Example call</h4> |
713 |
<h3>Example call</h3> |
| 714 |
<a href="ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1"> |
714 |
<a href="ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1"> |
| 715 |
ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1 |
715 |
ilsdi.pl?service=RenewLoan&patron_id=1&item_id=1 |
| 716 |
</a> |
716 |
</a> |
| 717 |
|
717 |
|
| 718 |
<h4>Example response</h4> |
718 |
<h3>Example response</h3> |
| 719 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
719 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 720 |
<RenewLoan> |
720 |
<RenewLoan> |
| 721 |
<success>0</success> |
721 |
<success>0</success> |
|
Lines 728-734
Link Here
|
| 728 |
<h2>HoldTitle</h2> |
728 |
<h2>HoldTitle</h2> |
| 729 |
<p>Creates, for a patron, a title-level hold request on a given bibliographic record in Koha.</p> |
729 |
<p>Creates, for a patron, a title-level hold request on a given bibliographic record in Koha.</p> |
| 730 |
|
730 |
|
| 731 |
<h4>Parameters</h4> |
731 |
<h3>Parameters</h3> |
| 732 |
<dl> |
732 |
<dl> |
| 733 |
<dt><strong>patron_id</strong> (Required)</dt> |
733 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 734 |
<dd>the ILS identifier for the patron for whom the request is placed</dd> |
734 |
<dd>the ILS identifier for the patron for whom the request is placed</dd> |
|
Lines 744-755
Link Here
|
| 744 |
<dd>date after which item returned to shelf if item is not picked up</dd> |
744 |
<dd>date after which item returned to shelf if item is not picked up</dd> |
| 745 |
</dl> |
745 |
</dl> |
| 746 |
|
746 |
|
| 747 |
<h4>Example Call</h4> |
747 |
<h3>Example Call</h3> |
| 748 |
<a href="ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1"> |
748 |
<a href="ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1"> |
| 749 |
ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1 |
749 |
ilsdi.pl?service=HoldTitle&patron_id=1&bib_id=1&request_location=127.0.0.1 |
| 750 |
</a> |
750 |
</a> |
| 751 |
|
751 |
|
| 752 |
<h4>Example response</h4> |
752 |
<h3>Example response</h3> |
| 753 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
753 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 754 |
<HoldTitle> |
754 |
<HoldTitle> |
| 755 |
<title>(les) galères de l'Orfèvre</title> |
755 |
<title>(les) galères de l'Orfèvre</title> |
|
Lines 762-768
Link Here
|
| 762 |
<h2>HoldItem</h2> |
762 |
<h2>HoldItem</h2> |
| 763 |
<p>Creates, for a patron, an item-level hold request on a specific item of a bibliographic record Koha.</p> |
763 |
<p>Creates, for a patron, an item-level hold request on a specific item of a bibliographic record Koha.</p> |
| 764 |
|
764 |
|
| 765 |
<h4>Parameters</h4> |
765 |
<h3>Parameters</h3> |
| 766 |
<dl> |
766 |
<dl> |
| 767 |
<dt><strong>patron_id</strong> (Required)</dt> |
767 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 768 |
<dd>the ILS identifier for the patron for whom the request is placed</dd> |
768 |
<dd>the ILS identifier for the patron for whom the request is placed</dd> |
|
Lines 778-789
Link Here
|
| 778 |
<dd>date after which item returned to shelf if item is not picked up</dd> |
778 |
<dd>date after which item returned to shelf if item is not picked up</dd> |
| 779 |
</dl> |
779 |
</dl> |
| 780 |
|
780 |
|
| 781 |
<h4>Example Call</h4> |
781 |
<h3>Example Call</h3> |
| 782 |
<a href="ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1"> |
782 |
<a href="ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1"> |
| 783 |
ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1 |
783 |
ilsdi.pl?service=HoldItem&patron_id=1&bib_id=1&item_id=1 |
| 784 |
</a> |
784 |
</a> |
| 785 |
|
785 |
|
| 786 |
<h4>Example response</h4> |
786 |
<h3>Example response</h3> |
| 787 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
787 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 788 |
<HoldTitle> |
788 |
<HoldTitle> |
| 789 |
<title>(les) galères de l'Orfèvre</title> |
789 |
<title>(les) galères de l'Orfèvre</title> |
|
Lines 796-802
Link Here
|
| 796 |
<h2>CancelHold</h2> |
796 |
<h2>CancelHold</h2> |
| 797 |
<p>Cancels an active hold request for the patron.</p> |
797 |
<p>Cancels an active hold request for the patron.</p> |
| 798 |
|
798 |
|
| 799 |
<h4>Parameters</h4> |
799 |
<h3>Parameters</h3> |
| 800 |
<dl> |
800 |
<dl> |
| 801 |
<dt><strong>patron_id</strong> (Required)</dt> |
801 |
<dt><strong>patron_id</strong> (Required)</dt> |
| 802 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
802 |
<dd>the unique patron identifier in the ILS; the same identifier returned by LookupPatron or AuthenticatePatron</dd> |
|
Lines 804-815
Link Here
|
| 804 |
<dd>system hold identifier (returned by GetRecords and GetPatronInfo into element 'reserve_id')</dd> |
804 |
<dd>system hold identifier (returned by GetRecords and GetPatronInfo into element 'reserve_id')</dd> |
| 805 |
</dl> |
805 |
</dl> |
| 806 |
|
806 |
|
| 807 |
<h4>Example call</h4> |
807 |
<h3>Example call</h3> |
| 808 |
<a href="ilsdi.pl?service=CancelHold&patron_id=1&item_id=1"> |
808 |
<a href="ilsdi.pl?service=CancelHold&patron_id=1&item_id=1"> |
| 809 |
ilsdi.pl?service=CancelHold&patron_id=1&item_id=1 |
809 |
ilsdi.pl?service=CancelHold&patron_id=1&item_id=1 |
| 810 |
</a> |
810 |
</a> |
| 811 |
|
811 |
|
| 812 |
<h4>Example response</h4> |
812 |
<h3>Example response</h3> |
| 813 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
813 |
<pre><?xml version="1.0" encoding="ISO-8859-1" ?> |
| 814 |
<CancelHold> |
814 |
<CancelHold> |
| 815 |
<message>Canceled</message> |
815 |
<message>Canceled</message> |