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