Ready to Learn?Ex Libris products all provide open APIs

Photocopies

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron's photocopy requests information. The photocopy requests information may be retrieved as a patron's photocopy requests list, or as a specific photocopy request's information. The photocopy requests list information is exported per institution (ADM library).

The resource may be accessed with a DELETE method to cancel a photocopy request.


Product Version Compatibility

Versions 18, 20.1 and later


Interface Type

RESTful API

 

Hierarchy

 

Slide11_patron-patron_id-circactions-requests-photocopies

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Photocopy ID: The ID of the specific photocopy request that is requested. May be used to fetch a specific photocopy request's information.

URL Parameters:

institution: The ID of an institution (ADM library) for which the information is requested. Optional.

view: The format in which the photocopy request list will be displayed. Possible values are brief and full. Optional.


Input URI

Photocopy Requests List:

<Base URL>:/patron/<patron ID>/circulationActions/requests/photocopies?institution=<Institution ID>

For example:

To retrieve the photocopy requests list for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies

To retrieve the photocopy requests list for the patron ID 00000036 for a specific institution, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?institution=USM50

To retrieve the photocopy requests list for the patron ID 00000036 in brief format, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?view=brief

To retrieve the photocopy requests list for the patron ID 00000036 in full format, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?view=full

Specific Photocopy Request:

<Base URL>:/patron/<patron ID>/circulationActions/requests/photocopies/<photocopy ID>

For example:

To retrieve a specific photocopy request's information for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies/USM500000002340001

Use the same URL with a DELETE method to cancel a photocopy request.


Output XML Format

The returned XML includes the patron's photocopy requests lists per institution, or a specific photocopy request's information.

The information is exported as Z38,Z30 and Z13 tags. When setting the view parameter to full, the records are fully extracted. When setting the view parameter to brief, only some of the elements are extracted.

Note the delete attribute, which indicates whether or not the request may be cancelled  in a DELETE action.

The list of institutes can be limited to those in which the patron is active, depending on the institute's setup of the FILTER-LIBRARY-CARD tab100 variable.

Photocopy requests list example:

<?xml version="1.0" encoding="UTF-8"?>
<pat-photo-list>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <photocopy-requests>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <photocopy-request delete="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies/USM500000002340001"/>
    </institution>
    <translate-change-active-library>USM51</translate-change-active-library>
    <institution code="USM51">
      <inst-name>USM51 Demo Libraries</inst-name>
    </institution>
    <translate-change-active-library>MAB50</translate-change-active-library>
    <institution code="MAB50">
      <inst-name>MAB Demo Library</inst-name>
    </institution>
  </photocopy-requests>
</pat-photo-list>
Specific photocopy request example:
<?xml version="1.0" encoding="UTF-8"?>
<get-pat-photo>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <photocopy-request delete="N">
    <z38>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z38-doc-number>000000234</z38-doc-number>
      <z38-sequence>0001</z38-sequence>
      <z38-item-sequence>000020</z38-item-sequence>
      <z38-id>00000036</z38-id>
      <z38-number>383</z38-number>
      <z38-status>In process</z38-status>
      <z38-open-date>20060228</z38-open-date>
      <z38-update-date>20060228</z38-update-date>
      <z38-alpha>L</z38-alpha>
      <z38-author/>
      <z38-title>part 1</z38-title>
      <z38-pages/>
      <z38-note-1/>
      <z38-note-2/>
      <z38-charge>C</z38-charge>
      <z38-requester-id/>
      <z38-print-status>P</z38-print-status>
      <z38-cataloger-name>MASTER</z38-cataloger-name>
      <z38-cataloger-ip>10.1.235.173</z38-cataloger-ip>
      <z38-pickup-location>Main Library</z38-pickup-location>
      <z38-send-action>00</z38-send-action>
      <z38-filter-sub-library>WID</z38-filter-sub-library>
      <z38-filter-item-status>01</z38-filter-item-status>
      <z38-filter-process-status/>
      <z38-filter-collection>GEN</z38-filter-collection>
      <z38-filter-pages/>
      <z38-enumeration-a/>
      <z38-enumeration-b/>
      <z38-enumeration-c/>
      <z38-chronological-i/>
      <z38-chronological-j/>
      <z38-chronological-k/>
      <z38-requester-name/>
      <z38-upd-time-stamp>200001011200000</z38-upd-time-stamp>
      <z38-additional-info/>
      <z38-cataloger-ip-v6/>
    </z38>
    <z30-sub-library-code>WID</z30-sub-library-code>
    <z30>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z30-doc-number>000000234</z30-doc-number>
      <z30-item-sequence>    2.0</z30-item-sequence>
      <z30-barcode>32044044493096</z30-barcode>
      <z30-sub-library>Main Library</z30-sub-library>
      <z30-material>Issue (bound)</z30-material>
      <z30-item-status>Regular loan</z30-item-status>
      <z30-open-date>19961110</z30-open-date>
      <z30-update-date>20000229</z30-update-date>
      <z30-cataloger>CONV</z30-cataloger>
      <z30-date-last-return>19961216</z30-date-last-return>
      <z30-hour-last-return>1530</z30-hour-last-return>
      <z30-ip-last-return>CONV</z30-ip-last-return>
      <z30-no-loans>001</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>43744.67.31 1970-</z30-call-no>
      <z30-call-no-key>00000 43744 0067 0031 1970</z30-call-no-key>
      <z30-call-no-2-type/>
      <z30-call-no-2/>
      <z30-call-no-2-key/>
      <z30-description>no2</z30-description>
      <z30-note-opac/>
      <z30-note-circulation/>
      <z30-note-internal/>
      <z30-order-number/>
      <z30-inventory-number/>
      <z30-inventory-number-date>00000000</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>000000234</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>00000000</z30-issue-date>
      <z30-expected-arrival-date>0</z30-expected-arrival-date>
      <z30-arrival-date>0</z30-arrival-date>
      <z30-item-statistic/>
      <z30-item-process-status>Not in Process</z30-item-process-status>
      <z30-copy-id/>
      <z30-hol-doc-number>000000403</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>000</z30-maintenance-count>
      <z30-process-status-date>00000000</z30-process-status-date>
      <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
      <z30-ip-last-return-v6/>
    </z30>
    <z13>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z13-doc-number>000000234</z13-doc-number>
      <z13-year>1927</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20040307</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code/>
      <z13-call-no/>
      <z13-author-code/>
      <z13-author/>
      <z13-title-code>24504</z13-title-code>
      <z13-title>Les cahiers Marcel Proust.</z13-title>
      <z13-imprint-code>260</z13-imprint-code>
      <z13-imprint>Paris : Gallimard, 1927-</z13-imprint>
      <z13-isbn-issn-code/>
      <z13-isbn-issn/>
      <z13-upd-time-stamp>200001011200000</z13-upd-time-stamp>
    </z13>
  </photocopy-request>
</get-pat-photo>
Cancel photocopy request example:
<?xml version="1.0" encoding="UTF-8"?>
<del-pat-photo>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <note type="info">Action Succeeded</note>
</del-pat-photo>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

05 : Request does not belong to the requested patron

08 : Request does not exist

13 : Request Cancellation failed