binding
General Purpose
This services performs check-out and check-in of an item for binding.
Interface Type
X-Service
Product Version Compatibility
Version 20
Input Parameters
- LIBRARY – X (5).
- BARCODE – X (15).
- BINDER_ID – X (10).
- ACTION – X (10).
- PERFORM_LOAN – X (1).
- PROC_STATUS – X (2).
- ARRIVAL_DATE – 9 (8).
- RETURN_HOUR – 9 (4).
- Library: Mandatory field. The library to which the binder and the bound item belong.
- Barcode: Mandatory field. The item barcode.
- Binder_Id: Binder identifier. The field is mandatory if the perform_loan parameter is Y.
- Action: Mandatory field. This field can contain one of two values: CHECKOUT or CHECKIN.
- Perform_Loan: Whether or not a loan is regsitered when the item is set to binding. Possible values are Y or N. Default value is ‘N’.
- Proc_Status: The new process status that is assigned to the bound item.
- Arrival_Date: Expected date of return from bindery. This is the due date if a loan is registered.
- Return_Hour: Expected hour of return from bindery. This is the due hour if a loan is registered.
Output XML Format
The output XML includes the following information about the patron:
- Item information (Z30).
If the perform_loan parameter is Y then the following is also included in the XML output:
- Binder’s global information (Z303).
- Binder’s addresses and phone numbers (Z304).
- Binder’s local record (Z305).
If a loan or a return action has been performed, then the following is also included in the XML output:
- Loan Item Information (Z36).
Example
To send an item with the barcode = 32044003924339 to binding, use a URL such as:
If all goes well, the XML output appears as follows:
<?xml version = "1.0" encoding = "UTF-8"?>
<binding>
<z30>
<z30-doc-number>15</z30-doc-number>
<z30-item-sequence>10</z30-item-sequence>
<z30-barcode>32044003924339</z30-barcode>
<z30-sub-library>Main Library</z30-sub-library>
<z30-material>Book</z30-material>
<z30-item-status>Advance Booking ENG</z30-item-status>
<z30-open-date>13/10/1988</z30-open-date>
<z30-update-date>14/07/2018</z30-update-date>
<z30-cataloger>EXLIBRIS</z30-cataloger>
<z30-date-last-return>04/11/2001</z30-date-last-return>
<z30-hour-last-return>15:16</z30-hour-last-return>
<z30-ip-last-return>CONV</z30-ip-last-return>
<z30-no-loans>005</z30-no-loans>
<z30-alpha>L</z30-alpha>
<z30-collection>General</z30-collection>
<z30-call-no-type>7</z30-call-no-type>
<z30-call-no>Heb 2106.385.5</z30-call-no>
<z30-call-no-key>7 $$2zhcl$$hheb 2106.385.5</z30-call-no-key>
<z30-call-no-2-type/>
<z30-call-no-2/>
<z30-call-no-2-key/>
<z30-description>v.1</z30-description>
<z30-note-opac/>
<z30-note-circulation/>
<z30-note-internal/>
<z30-order-number/>
<z30-inventory-number/>
<z30-inventory-number-date/>
<z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
<z30-price/>
<z30-shelf-report-number/>
<z30-on-shelf-date>00000000</z30-on-shelf-date>
<z30-on-shelf-seq>000000</z30-on-shelf-seq>
<z30-doc-number-2>000000015</z30-doc-number-2>
<z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
<z30-copy-sequence-2>00000</z30-copy-sequence-2>
<z30-vendor-code/>
<z30-invoice-number/>
<z30-line-number>00000</z30-line-number>
<z30-pages/>
<z30-issue-date/>
<z30-expected-arrival-date/>
<z30-arrival-date/>
<z30-item-statistic/>
<z30-item-process-status>XX</z30-item-process-status>
<z30-copy-id>1</z30-copy-id>
<z30-hol-doc-number>000000046</z30-hol-doc-number>
<z30-temp-location>No</z30-temp-location>
<z30-enumeration-a/>
<z30-enumeration-b/>
<z30-enumeration-c/>
<z30-enumeration-d/>
<z30-enumeration-e/>
<z30-enumeration-f/>
<z30-enumeration-g/>
<z30-enumeration-h/>
<z30-chronological-i/>
<z30-chronological-j/>
<z30-chronological-k/>
<z30-chronological-l/>
<z30-chronological-m/>
<z30-supp-index-o/>
<z30-85x-type/>
<z30-depository-id/>
<z30-linking-number>000000000</z30-linking-number>
<z30-gap-indicator/>
<z30-maintenance-count>001</z30-maintenance-count>
<z30-process-status-date>20181113</z30-process-status-date>
<z30-upd-time-stamp>201811131454494</z30-upd-time-stamp>
<z30-ip-last-return-v6/>
</z30>
<z303>
<z303-id>00000012</z303-id>
<z303-proxy-for-id/>
<z303-primary-id/>
<z303-name-key>aaberg oscar 00000012</z303-name-key>
<z303-user-type>REG</z303-user-type>
<z303-user-library/>
<z303-open-date>23/06/1989</z303-open-date>
<z303-update-date>25/04/2018</z303-update-date>
<z303-con-lng>ENG</z303-con-lng>
<z303-alpha>L</z303-alpha>
<z303-name>Aaberg, Oscar</z303-name>
<z303-title/>
<z303-delinq-1>00</z303-delinq-1>
<z303-delinq-n-1/>
<z303-delinq-1-update-date>00000000</z303-delinq-1-update-date>
<z303-delinq-1-cat-name>CONVERSION</z303-delinq-1-cat-name>
<z303-delinq-2>00</z303-delinq-2>
<z303-delinq-n-2/>
<z303-delinq-2-update-date>00000000</z303-delinq-2-update-date>
<z303-delinq-2-cat-name>CONVERSION</z303-delinq-2-cat-name>
<z303-delinq-3>00</z303-delinq-3>
<z303-delinq-n-3/>
<z303-delinq-3-update-date>00000000</z303-delinq-3-update-date>
<z303-delinq-3-cat-name>CONVERSION</z303-delinq-3-cat-name>
<z303-budget/>
<z303-profile-id>00000012</z303-profile-id>
<z303-ill-library>AUTO</z303-ill-library>
<z303-home-library>Law Library</z303-home-library>
<z303-field-1/>
<z303-field-2/>
<z303-field-3/>
<z303-note-1/>
<z303-note-2/>
<z303-salutation/>
<z303-ill-total-limit>0250</z303-ill-total-limit>
<z303-ill-active-limit>0200</z303-ill-active-limit>
<z303-dispatch-library/>
<z303-birth-date/>
<z303-export-consent>Y</z303-export-consent>
<z303-proxy-id-type>00</z303-proxy-id-type>
<z303-send-all-letters>Y</z303-send-all-letters>
<z303-plain-html>L</z303-plain-html>
<z303-want-sms>Y</z303-want-sms>
<z303-plif-modification/>
<z303-title-req-limit>9999</z303-title-req-limit>
<z303-gender/>
<z303-birthplace/>
<z303-upd-time-stamp>201804251141474</z303-upd-time-stamp>
<z303-last-name/>
<z303-first-name/>
</z303>
<z305>
<z305-id>00000012</z305-id>
<z305-sub-library>WID</z305-sub-library>
<z305-open-date>10/04/2017</z305-open-date>
<z305-update-date>13/11/2018</z305-update-date>
<z305-bor-type/>
<z305-bor-status>Faculty</z305-bor-status>
<z305-registration-date>00000000</z305-registration-date>
<z305-expiry-date>19/03/2019</z305-expiry-date>
<z305-note/>
<z305-loan-permission>Y</z305-loan-permission>
<z305-photo-permission>N</z305-photo-permission>
<z305-over-permission>Y</z305-over-permission>
<z305-multi-hold>N</z305-multi-hold>
<z305-loan-check>Y</z305-loan-check>
<z305-hold-permission>Y</z305-hold-permission>
<z305-renew-permission>Y</z305-renew-permission>
<z305-rr-permission>Y</z305-rr-permission>
<z305-ignore-late-return>N</z305-ignore-late-return>
<z305-last-activity-date>13/11/2018</z305-last-activity-date>
<z305-photo-charge>C</z305-photo-charge>
<z305-no-loan>0000</z305-no-loan>
<z305-no-hold>0000</z305-no-hold>
<z305-no-photo>0000</z305-no-photo>
<z305-no-cash>0000</z305-no-cash>
<z305-cash-limit>0.00</z305-cash-limit>
<z305-credit-debit/>
<z305-sum>0.00</z305-sum>
<z305-delinq-1>00</z305-delinq-1>
<z305-delinq-n-1/>
<z305-delinq-1-update-date>20170410</z305-delinq-1-update-date>
<z305-delinq-1-cat-name>MASTER</z305-delinq-1-cat-name>
<z305-delinq-2>00</z305-delinq-2>
<z305-delinq-n-2/>
<z305-delinq-2-update-date>20170410</z305-delinq-2-update-date>
<z305-delinq-2-cat-name>MASTER</z305-delinq-2-cat-name>
<z305-delinq-3>00</z305-delinq-3>
<z305-delinq-n-3/>
<z305-delinq-3-update-date>20170410</z305-delinq-3-update-date>
<z305-delinq-3-cat-name>MASTER</z305-delinq-3-cat-name>
<z305-field-1/>
<z305-field-2/>
<z305-field-3/>
<z305-hold-on-shelf>N</z305-hold-on-shelf>
<z305-end-block-date/>
<z305-booking-permission>N</z305-booking-permission>
<z305-booking-ignore-hours>N</z305-booking-ignore-hours>
<z305-rush-cat-request>Y</z305-rush-cat-request>
<z305-upd-time-stamp>201811131454492</z305-upd-time-stamp>
</z305>
<z36>
<z36-doc-number>000000015</z36-doc-number>
<z36-item-sequence>000010</z36-item-sequence>
<z36-id>00000012</z36-id>
<z36-number>000009271</z36-number>
<z36-material>BOOK</z36-material>
<z36-sub-library>Main Library</z36-sub-library>
<z36-status>A</z36-status>
<z36-loan-date>13/11/2018</z36-loan-date>
<z36-loan-hour>14:54</z36-loan-hour>
<z36-effective-due-date>00000000</z36-effective-due-date>
<z36-due-date>13/11/2018</z36-due-date>
<z36-due-hour>14:54</z36-due-hour>
<z36-returned-date/>
<z36-returned-hour/>
<z36-item-status>44</z36-item-status>
<z36-bor-status>Faculty</z36-bor-status>
<z36-letter-number>0</z36-letter-number>
<z36-letter-date/>
<z36-no-renewal>0</z36-no-renewal>
<z36-note-1/>
<z36-note-2/>
<z36-loan-cataloger-name/>
<z36-loan-cataloger-ip>10.1.116.222</z36-loan-cataloger-ip>
<z36-return-cataloger-name/>
<z36-return-cataloger-ip/>
<z36-renew-cataloger-name/>
<z36-renew-cataloger-ip/>
<z36-renew-mode/>
<z36-bor-type/>
<z36-note-alpha/>
<z36-recall-date/>
<z36-recall-due-date/>
<z36-last-renew-date/>
<z36-original-due-date>13/11/2018</z36-original-due-date>
<z36-process-status/>
<z36-loan-type/>
<z36-proxy-id/>
<z36-recall-type/>
<z36-return-location/>
<z36-return-sub-location/>
<z36-source/>
<z36-delivery-time/>
<z36-tail-time/>
<z36-upd-time-stamp>201811131454487</z36-upd-time-stamp>
<z36-loan-cataloger-ip-v6/>
<z36-return-cataloger-ip-v6/>
<z36-renew-cataloger-ip-v6/>
</z36>
<session-id>765SBVSH3QVAPELB65VTVBANDHPFPCP4NTCE8EFJDEXKJVSS4L</session-id>
</binding>Possible Error Codes
1. If the user tried to activate the X-Service without putting a value in the Barcode field, the following error message is displayed in the XML output:
<error>Barcode parameter is missing</error>
2. If the user tried to activate the X-Service without putting a value in the Binder_Id field, the following error message is displayed in the XML output:
<error>Binder parameter is missing </error>
3. If the user tried to activate the X-Service without putting a value in the Action field or the value entered is not ‘CHECKIN’ or ‘CHECKOUT,’ the following error message is displayed in the XML output:
<error>Invalid Action </error>
4. If the X-Service failed to retrieve the Barcode, the following error message is displayed in the XML output:
<error>Item does not exist </error>
5. If the X-Service failed to retrieve the Binder Information, the following error message is displayed in the XML output:
<error>Unable to find Binder information </error>
6. If the value in the Action field is CHECKOUT, perform_loan=Y, and the Item is already on loan, the following error message is displayed in the XML output:
<error> Item already on loan </error>
7. If the X-Service failed to update the Item Information, the following error message is displayed in the XML output:
<error> Unable to update item </error>
8. If the value in the Action field is CHECKIN, perform_loan=Y, and the Item is not on loan, the following error message is displayed in the XML output:
<error>Item is not on loan </error>
9. If the X-Service failed to delete the loan when the value in the Action field is CHECKIN, the following error message is displayed in the XML output:
<error>Unable to delete loan </error>
10. If the value in the Action field is CHECKIN, perform_loan=Y, and the Item is on hold, the following error message is displayed in the XML output:
<error>Item is on hold </error>
11. If the X-Service failed to loan an item when the value in the Action field is CHECKOUT, the following error message is displayed in the XML output:
<error>Could not loan the item </error>
12. If the X-Service failed to loan the booked item when the value in the Action field is CHECKOUT, the following error message is displayed in the XML output:
<error>Item is booked and cannot be loaned </error>