digital_bin

General Purpose

This service retrieves e-Shelf information for a given patron ID/session key and sequence.

It retrieves all records in the given e-Shelf folder unless an error message is returned.

Input Parameters

1.  BIN_ID/ DIGITAL_BIN_ID – PICTURE X(50).
2. BIN_SEQUENCE/ DIGITAL_BIN_SEQUENCE – PICTURE 9(5).

  • BIN_ID/ DIGITAL_BIN_ID: ID of the patron (from the Z312 table), or the session from which the user wants to get e-Shelf information.
  • BIN_SEQUENCE/ DIGITAL_BIN_SEQUENCE: The sequence in the Z129 table of the e-shelf that the user wants to get. This should be the sequence of the folder record in the e-Shelf (Z129) table with Z129_TYPE F and with Z129_PUBLIC Y.

Output XML Format

The output XML includes all e-Shelf records (Z129) in the folder defined by the user combined with the patron ID/session and sequence.

Example:
To get e-shelf information for borrower_id=PATRON104 and sequence=2 (folder name = new1) in the address bar of your Web browser, enter the following URL:

http://ram7:8175/X?op=digital_bin&BIN_ID=PATRON104&BIN_SEQUENCE=2

If successful, the output XML includes all of the Z129 records in the new1 folder:

<sds:digital-bin xmlns:sds="http://com/exlibris/digitool/sds/xmlbeans">
  <sds:public-name>new1</sds:public-name>
  <sds:public-desc>new11</sds:public-desc>
  <sds:no-elements>000000006</sds:no-elements>
    <sds:elements>
    <sds:element>
    <sds:z129>
      <sds:z129-id>PATRON104</sds:z129-id>
      <sds:z129-sequence>00001</sds:z129-sequence>
      <sds:z129-note />
      <sds:z129-object-id>DTL02000000186000001</sds:z129-object-id>
      <sds:z129-sort-field>00001</sds:z129-sort-field>
    </sds:z129>
    </sds:element>
    <sds:element>
    <sds:z129>
      <sds:z129-id>PATRON104</sds:z129-id>
      <sds:z129-sequence>00003</sds:z129-sequence>
      <sds:z129-note />
      <sds:z129-object-id>DTL02000000003000001</sds:z129-object-id>
      <sds:z129-sort-field>00003</sds:z129-sort-field>
    </sds:z129>
    </sds:element>
    <sds:element>
    <sds:z129>
        <sds:z129-id>PATRON104</sds:z129-id>
        <sds:z129-sequence>00004</sds:z129-sequence>
      <sds:z129-note />
        <sds:z129-object-id>DTL02000000063000001</sds:z129-object-id>
        <sds:z129-sort-field>00004</sds:z129-sort-field>
      </sds:z129>
      </sds:element>
      <sds:element>
      <sds:z129>
        <sds:z129-id>PATRON104</sds:z129-id>
        <sds:z129-sequence>00005</sds:z129-sequence>
      <sds:z129-note />
        <sds:z129-object-id>DTL02000000261000001</sds:z129-object-id>

        <sds:z129-sort-field>00005</sds:z129-sort-field>
      </sds:z129>
      </sds:element>
      <sds:element>
      <sds:z129>
        <sds:z129-id>PATRON104</sds:z129-id>
        <sds:z129-sequence>00006</sds:z129-sequence>
      <sds:z129-note />
        <sds:z129-object-id>DTL02000000175000001</sds:z129-object-id>
        <sds:z129-sort-field>00006</sds:z129-sort-field>
        </sds:z129>
      </sds:element>
      <sds:element>
        <sds:z129>
          <sds:z129-id>PATRON104</sds:z129-id>
          <sds:z129-sequence>00007</sds:z129-sequence>
        <sds:z129-note />
          <sds:z129-object-id>DTL02000000009000001</sds:z129-object-id>
          <sds:z129-sort-field>00007</sds:z129-sort-field>
        </sds:z129>
      </sds:element>
    </sds:elements>
  <session-id>A75BSYRIMY3F382I4MCRXH1C3J1VQRJX3SV9A48UYGI3BSAJTJ</session-id>
</sds:digital-bin>

Possible Error Codes

1. If the digital_bin X-Service is activated without bin_id having been entered, the following message appears in the output XML:

<error>The digital bin id is missing</error>

2. If the bin_sequence has not been entered or the bin_id and bin_sequence do not exist in the Z129 table, the following message appears:

<error>No valid entry in Z129 for specified digital bin id</error>