Ready to Learn?Ex Libris products all provide open APIs


General Purpose

This service retrieves the OAI XML format of an expanded document as given by the user.


Interface Type



Product Version Compatibility

Version 18 and later


Input Parameters

1. BASE - X (20).
2. FORMAT - X (5).
3. DOC_NUMBER - X (9).
4. CHAR_CONV - X(20).
5. SHOW_SUB6 - X(1).

  • Base: Enter the base in which the give document resides.
  • Format / Record_Format: marc or marc_latin. Format is not mandatory and the default is marc.
  • Doc_Number / Doc_Num: The document for which you want to get OAI XML format.
  • Char_Conv: In the event that character conversion is needed, add the matching definition as in the he_root/unicode/tab_character_conversion_line table. For example, UTF_TO_8859_1.
    Note that this parameter is not mandatory. If it is not provided, no character conversion is performed.
  • Show_sub6: (Aleph 20 and later) If this is set to "Y" or "y", for example, "show_sub6=Y", the contents of subfield $6 (Linkage) is shown if it is included in the record.


Output XML Format

The XML output includes the OAI format of the given document. The fields included in the XML are based on the expand procedures defined in tab_expand of the given base for WWW-X.

If you want to get OAI XML for document 444 in USM90, enter the following URL:


If everything goes well, the example above generates XML output similar to the following:

<?xml version="1.0" encoding="UTF-8" ?>
- <find-doc>
- <record>
- <metadata>
- <oai_marc>
<fixfield id="FMT">BK</fixfield>
- <varfield id="SID" i1="" i2="">
<subfield label="b">LAD</subfield>
<subfield label="c">ACJ71282</subfield>
<fixfield id="005">20001223000000.0</fixfield>
- <varfield id="035" i1="9" i2="">
<subfield label="a">3236741</subfield>
- <varfield id="035" i1="" i2="">
<subfield label="a">(OCoLC)14926036</subfield>
- <varfield id="040" i1="" i2="">
<subfield label="a">CLU</subfield>
<subfield label="c">CLU</subfield>
- <varfield id="100" i1="1" i2="">
<subfield label="a">Cicero, Marcus
- <varfield id="245" i1="0" i2="0">
<subfield label="a">De officiis libri
<subfield label="c">Recensuit et scholiis Jacobi
Facciolati suisque animadversionibus instruxit Aug. Gotth.
- <varfield id="260" i1="" i2="">
<subfield label="a">Lipsiae,</subfield>
<subfield label="b">Apud Gerhardum
<subfield label="c">1811.</subfield>
- <varfield id="300" i1="" i2="">
<subfield label="a">xxxii, 464 p.</subfield>
- <varfield id="700" i1="1" i2="">
<subfield label="a">Facciolati, Jacobo,</subfield>
<subfield label="d">1682-1769.</subfield>
- <varfield id="700" i1="1" i2="">
<subfield label="a">Gernhard, August
<subfield label="d">1777-1845.</subfield>
- <varfield id="852" i1="" i2="">
<subfield label="a">LAD</subfield>
<subfield label="b">SRLF</subfield>
<subfield label="j">AA0004401121</subfield>
<subfield label="p">AA0004401121</subfield>
- <varfield id="901" i1="" i2="">
<subfield label="a">LAD</subfield>
<subfield label="b">ACJ71282</subfield>
- <varfield id="CAT" i1="" i2="">
<subfield label="c">20020505</subfield>
<subfield label="l">USM90</subfield>
<subfield label="h">1001</subfield>





Possible Error Codes

1. If you provided a format different to marc or marc_latin, the following error message appears in the XML output:

< error>Format must be marc or marc_latin</error>

2. If the document given cannot be found under the base you have given, the following message appears in the XML output:

< error>Error reading Document</error>