Ready to Learn?Ex Libris products all provide open APIs

present

General Purpose

This service retrieves OAI XML format of expanded documents.

You can view documents according to the locations within a specific set number.

 

Interface Type

X-Service

 

Product Version Compatibility

Version 18 and later

 

Input Parameters

1. SET_NUMBER . 9 (6).
2. SET_ENTRY . 9 (9).
3. FORMAT . X (10).
4. CHAR_CONV . X (20).
5. SHOW_SUB6 - X(1).
 

  • Set_Number / Set_No: Set number in which set entries are to be checked. This parameter is mandatory.
  • Set_Entry: This field contains the set entries within the given set number. The set entries represent the entries in the Z110 (documents) to be viewed in OAI XML format. There are two possible formats:
    • Range of entries 000000001-0000000012

      This means that you want to get information on documents located in entries 1 to 12 within the given set number. In this format, the order should be lower number entry-higher number entry. Note that the service will display only the first 100 records in a given range. In this case (range bigger than 100) you may choose to use the find X-service.

      Alternatively - for displaying more than 100 records - you may split your request to two or more as follows:
      set_entry=000000001-000000100and then: set_entry=000000101-000000200 etc.
       
    • Single documents, separated into entries 000000001, 000000005, 0000000010. This means that you want to get information on documents located in entries 1, 5, and 10 within the given set number.
      In both formats, the number of requested entries must not exceed 99.

      You do not have to use leading zeroes in set_entry (that is, set_entry=000000001 and set_entry=1 are both valid options). You cannot mix formats; and therefore, you must only use one of them (that is, set_entry=000000001-000000003,000000020 is forbidden).

      This parameter is mandatory.
       
  • Format / Record_Format: marc or marc_latin. Format is not mandatory and the default is marc.
  • Char_Conv: Character conversion in document.
  • 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 OAI XML format including the following data for each of the documents located in the range of set entries (or specific set entries) given:

  • Set Entry number
  • Document number
  • OAI format of the expand document, based on the expand procedures defined in the tab_expand table of the given base for WWW-X.

    Example:
    To get OAI XML output for set entries 1 to 3 under set number 000936, enter the following URL:
    http://ram19:8995/X?op=present&set_entry=000000001-000000003&set_number=000936
    


    If successful, the XML output is:

    <?xml version = "1.0" encoding = "UTF-8"?>
    <present>
    <record>
    <record_header>
    <set_entry>000000001</set_entry>
    </record_header>
    <doc_number>49714</doc_number>
    <metadata>
    <oai_marc>
    <fixfield id="FMT">SE</fixfield>
    <fixfield id="LDR">01036aas^^2200313^a^4500</fixfield>
    <fixfield id="001">000049714-2</fixfield>
    <fixfield id="005">20020418155342.1</fixfield>
    <fixfield
    id="008">790312c19669999ja^mr^p^^^^^^f0^^^d0jpn^d</fixfield>
    <varfield id="010" i1=" " i2=" ">
    <subfield label="a">^^^93659629^/AJ/V</subfield>
    </varfield>
    <varfield id="022" i1=" " i2=" ">
    <subfield label="a">0549-401X</subfield>
    </varfield>
    <varfield id="035" i1="0" i2=" ">
    <subfield label="a">(OCoLC)04733851</subfield>
    </varfield>
    <varfield id="037" i1=" " i2=" ">
    <subfield label="b">Shibund., 2-11-13 Nishi Waseda, Shinjuku-ku,
    Tokyo 169</subfield>
    </varfield>
    <varfield id="040" i1=" " i2=" ">
    <subfield label="a">COO</subfield>
    <subfield label="c">COO</subfield>
    <subfield label="d">MUL</subfield>
    <subfield label="d">IUL</subfield>
    <subfield label="d">OCL</subfield>
    <subfield label="d">DLC</subfield>
    <subfield label="d">HFL</subfield>
    </varfield>
    <varfield id="042" i1=" " i2=" ">
    <subfield label="a">lc</subfield>
    </varfield>
    <varfield id="043" i1=" " i2=" ">
    
    <subfield label="a">a-ja---</subfield>
    </varfield>
    <varfield id="050" i1="0" i2="0">
    <subfield label="a">N7353</subfield>
    <subfield label="b">.N537</subfield>
    </varfield>
    <varfield id="245" i1="0" i2="0">
    <subfield label="a">Nihon no bijutsu /</subfield>
    <subfield label="c">kansh. T.ky. Kokuritsu Hakubutsukan, Ky.to
    Kokuritsu Hakubutsukan, Nara Kokuritsu
    Hakubutsukan.</subfield>
    </varfield>
    <varfield id="260" i1=" " i2=" ">
    <subfield label="a">T.ky.-to :</subfield>
    <subfield label="b">Shibund.,</subfield>
    <subfield label="c">Sh.wa 41-nen [1966]-</subfield>
    </varfield>
    <varfield id="300" i1=" " i2=" ">
    <subfield label="a">v. :</subfield>
    <subfield label="b">ill. ;</subfield>
    <subfield label="c">23-25 cm.</subfield>
    </varfield>
    <varfield id="310" i1=" " i2=" ">
    <subfield label="a">Monthly</subfield>
    </varfield>
    <varfield id="362" i1="0" i2=" ">
    <subfield label="a">No. 1 ('66, 5)-</subfield>
    </varfield>
    <varfield id="500" i1=" " i2=" ">
    <subfield label="a">Each no. has also a distinctive
    title.</subfield>
    </varfield>
    <varfield id="650" i1=" " i2="0">
    <subfield label="a">Art, Japanese</subfield>
    <subfield label="y">To 1868</subfield>
    <subfield label="x">Periodicals.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">T.ky. Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">Ky.to Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">Nara Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1200</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1407</subfield>
    </varfield>
    </oai_marc>
    </metadata>
    </record>
    <record>
    <record_header>
    <set_entry>000000002</set_entry>
    </record_header>
    <doc_number>49283</doc_number>
    <metadata>
    <oai_marc>
    <fixfield id="FMT">BK</fixfield>
    <fixfield id="LDR">00717nam^^2200217^a^4500</fixfield>
    <fixfield id="001">000049283-3</fixfield>
    <fixfield id="005">20020418155342.1</fixfield>
    <fixfield
    id="008">960712s1928^^^^pl^^^^^^^b^^^^001^0^pol^d</fixfield>
    <varfield id="040" i1=" " i2=" ">
    <subfield label="a">HLS</subfield>
    <subfield label="c">HLS</subfield>
    <subfield label="d">HMM</subfield>
    </varfield>
    <varfield id="100" i1="1" i2=" ">
    <subfield label="a">Sobeski, Micha.,</subfield>
    <subfield label="d">1877-1939.</subfield>
    </varfield>
    <varfield id="245" i1="1" i2="0">
    <subfield label="a">Z pogranicza sztuki i filozofji
    /</subfield>
    <subfield label="c">Micha. Sobeski.</subfield>
    </varfield>
    <varfield id="260" i1=" " i2=" ">
    <subfield label="a">Pozna. :</subfield>
    <subfield label="b">Fiszer i Majewski,</subfield>
    <subfield label="c">1928.</subfield>
    </varfield>
    <varfield id="300" i1=" " i2=" ">
    <subfield label="a">268 p. ;</subfield>
    <subfield label="c">25 cm.</subfield>
    </varfield>
    <varfield id="504" i1=" " i2=" ">
    <subfield label="a">Includes bibliographical references and
    index.</subfield>
    </varfield>
    <varfield id="650" i1=" " i2="0">
    <subfield label="a">Aesthetics.</subfield>
    </varfield>
    <varfield id="650" i1=" " i2="0">
    <subfield label="a">Art</subfield>
    <subfield label="x">Philosophy.</subfield>
    </varfield>
    <varfield id="650" i1=" " i2="0">
    <subfield label="a">Literature</subfield>
    <subfield label="x">Philosophy.</subfield>
    </varfield>
    <varfield id="830" i1=" " i2="0">
    <subfield label="5">mmf</subfield>
    <subfield label="a">Harvard College Library preservation
    microfilm program ;</subfield>
    <subfield label="v">00788.</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1200</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1407</subfield>
    </varfield>
    </oai_marc>
    </metadata>
    </record>
    <record>
    <record_header>
    <set_entry>000000003</set_entry>
    </record_header>
    <doc_number>49238</doc_number>
    <metadata>
    <oai_marc>
    <fixfield id="FMT">BK</fixfield>
    <fixfield id="LDR">00908na9^^22001815a^4500</fixfield>
    <fixfield id="001">000049238-8</fixfield>
    <fixfield id="005">20020418155342.1</fixfield>
    <fixfield
    id="008">940921|||||||||gw^|||||||||||||||||ger||</fixfield>
    <varfield id="100" i1="1" i2=" ">
    <subfield label="a">Palandt, Otto,</subfield>
    <subfield label="d">1877-1951.</subfield>
    </varfield>
    <varfield id="245" i1="1" i2="0">
    <subfield label="a">Bürgerliches Gesetzbuch
    :</subfield>
    <subfield label="b">mit Einführungsgesetz, Gesetz zur
    Regelung des Rechts der Allgemeinen Geschäftsbedingungen,
    Verbraucherkreditgesetz, Gesetz über den Widerruf von
    Haustürgeschäften und ähnlichen Geschäften, Gesetz
    zur Regelung der
    Miethöhe (Art. 3 des 2. WKSchG), Produkthaftungsgesetz,
    Erbbaurechtsverordnung, Wohnungseigentumsgesetz, Ehegesetz,
    Hausratsverordnung /</subfield>
    <subfield label="c">Palandt ; bearbeitet von Peter Bassenge ...
    [et al.].</subfield>
    </varfield>
    <varfield id="260" i1=" " i2=" ">
    <subfield label="a">München :</subfield>
    <subfield label="b">C.H. Beck,</subfield>
    </varfield>
    <varfield id="490" i1="0" i2=" ">
    <subfield label="a">Beck'sche Kurz-Kommentare
    ;</subfield>
    <subfield label="v">Bd. 7</subfield>
    </varfield>
    <varfield id="700" i1="1" i2=" ">
    <subfield label="a">Bassenge, Peter.</subfield>
    </varfield>
    <varfield id="710" i1="1" i2="2">
    <subfield label="a">Germany.</subfield>
    <subfield label="t">Bürgerliches Gesetzbuch.</subfield>
    </varfield>
    <varfield id="STA" i1=" " i2=" ">
    <subfield label="a">SUPPRESSED</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1200</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1407</subfield>
    </varfield>
    </oai_marc>
    </metadata>
    </record>
    <session-id>Q6EDSR58UC9DHE1MRRYG6K4UAR3UJ7APB76ESRTJMH62X8SGGK</session-id>
    </present>
    


    To get OAI XML for set entries 1 and 3 under Set Number 000936 in base USM01 (unlike the first example, here we are not interested in set entry number 2), enter the following URL:

    http://ram19:8995/X?op=present&set_entry=000000001,000000003&set_number=000936&base=usm01
    


    If successful, the XML output is:

    <?xml version = "1.0" encoding = "UTF-8"?>
    <present>
    <record>
    <record_header>
    <set_entry>000000001</set_entry>
    </record_header>
    <doc_number>49714</doc_number>
    <metadata>
    <oai_marc>
    <fixfield id="FMT">SE</fixfield>
    <fixfield id="LDR">01036aas^^2200313^a^4500</fixfield>
    <fixfield id="001">000049714-2</fixfield>
    <fixfield id="005">20020418155342.1</fixfield>
    <fixfield
    id="008">790312c19669999ja^mr^p^^^^^^f0^^^d0jpn^d</fixfield>
    <varfield id="010" i1=" " i2=" ">
    <subfield label="a">^^^93659629^/AJ/V</subfield>
    </varfield>
    <varfield id="022" i1=" " i2=" ">
    <subfield label="a">0549-401X</subfield>
    </varfield>
    <varfield id="035" i1="0" i2=" ">
    <subfield label="a">(OCoLC)04733851</subfield>
    </varfield>
    <varfield id="037" i1=" " i2=" ">
    <subfield label="b">Shibund., 2-11-13 Nishi Waseda, Shinjuku-ku,
    Tokyo 169</subfield>
    
    </varfield>
    <varfield id="040" i1=" " i2=" ">
    <subfield label="a">COO</subfield>
    <subfield label="c">COO</subfield>
    <subfield label="d">MUL</subfield>
    <subfield label="d">IUL</subfield>
    <subfield label="d">OCL</subfield>
    <subfield label="d">DLC</subfield>
    <subfield label="d">HFL</subfield>
    </varfield>
    <varfield id="042" i1=" " i2=" ">
    <subfield label="a">lc</subfield>
    </varfield>
    <varfield id="043" i1=" " i2=" ">
    <subfield label="a">a-ja---</subfield>
    </varfield>
    <varfield id="050" i1="0" i2="0">
    <subfield label="a">N7353</subfield>
    <subfield label="b">.N537</subfield>
    </varfield>
    <varfield id="245" i1="0" i2="0">
    <subfield label="a">Nihon no bijutsu /</subfield>
    <subfield label="c">kansh. T.ky. Kokuritsu Hakubutsukan, Ky.to
    Kokuritsu Hakubutsukan, Nara Kokuritsu
    Hakubutsukan.</subfield>
    </varfield>
    <varfield id="260" i1=" " i2=" ">
    <subfield label="a">T.ky.-to :</subfield>
    <subfield label="b">Shibund.,</subfield>
    <subfield label="c">Sh.wa 41-nen [1966]-</subfield>
    </varfield>
    <varfield id="300" i1=" " i2=" ">
    <subfield label="a">v. :</subfield>
    <subfield label="b">ill. ;</subfield>
    <subfield label="c">23-25 cm.</subfield>
    </varfield>
    <varfield id="310" i1=" " i2=" ">
    <subfield label="a">Monthly</subfield>
    </varfield>
    <varfield id="362" i1="0" i2=" ">
    <subfield label="a">No. 1 ('66, 5)-</subfield>
    </varfield>
    <varfield id="500" i1=" " i2=" ">
    <subfield label="a">Each no. has also a distinctive
    title.</subfield>
    </varfield>
    <varfield id="650" i1=" " i2="0">
    <subfield label="a">Art, Japanese</subfield>
    <subfield label="y">To 1868</subfield>
    <subfield label="x">Periodicals.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">T.ky. Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">Ky.to Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="710" i1="2" i2=" ">
    <subfield label="a">Nara Kokuritsu Hakubutsukan.</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1200</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1407</subfield>
    </varfield>
    </oai_marc>
    </metadata>
    </record>
    <record>
    <record_header>
    <set_entry>000000003</set_entry>
    </record_header>
    <doc_number>49238</doc_number>
    <metadata>
    <oai_marc>
    <fixfield id="FMT">BK</fixfield>
    <fixfield id="LDR">00908na9^^22001815a^4500</fixfield>
    <fixfield id="001">000049238-8</fixfield>
    <fixfield id="005">20020418155342.1</fixfield>
    <fixfield
    id="008">940921|||||||||gw^|||||||||||||||||ger||</fixfield>
    <varfield id="100" i1="1" i2=" ">
    <subfield label="a">Palandt, Otto,</subfield>
    <subfield label="d">1877-1951.</subfield>
    </varfield>
    <varfield id="245" i1="1" i2="0">
    <subfield label="a">Bürgerliches Gesetzbuch
    :</subfield>
    <subfield label="b">mit Einführungsgesetz, Gesetz zur
    Regelung des Rechts der Allgemeinen Geschäftsbedingungen,
    Verbraucherkreditgesetz, Gesetz über den Widerruf von
    Haustürgeschäften und ähnlichen Geschäften, Gesetz
    zur Regelung der
    Miethöhe (Art. 3 des 2. WKSchG), Produkthaftungsgesetz,
    Erbbaurechtsverordnung, Wohnungseigentumsgesetz, Ehegesetz,
    Hausratsverordnung /</subfield>
    <subfield label="c">Palandt ; bearbeitet von Peter Bassenge ...
    [et al.].</subfield>
    </varfield>
    <varfield id="260" i1=" " i2=" ">
    <subfield label="a">München :</subfield>
    <subfield label="b">C.H. Beck,</subfield>
    </varfield>
    <varfield id="490" i1="0" i2=" ">
    <subfield label="a">Beck'sche Kurz-Kommentare
    ;</subfield>
    <subfield label="v">Bd. 7</subfield>
    </varfield>
    <varfield id="700" i1="1" i2=" ">
    <subfield label="a">Bassenge, Peter.</subfield>
    
    </varfield>
    <varfield id="710" i1="1" i2="2">
    <subfield label="a">Germany.</subfield>
    <subfield label="t">Bürgerliches Gesetzbuch.</subfield>
    </varfield>
    <varfield id="STA" i1=" " i2=" ">
    <subfield label="a">SUPPRESSED</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1200</subfield>
    </varfield>
    <varfield id="CAT" i1=" " i2=" ">
    <subfield label="a">CONV</subfield>
    <subfield label="b">00</subfield>
    <subfield label="c">20040307</subfield>
    <subfield label="l">USM01</subfield>
    <subfield label="h">1407</subfield>
    </varfield>
    </oai_marc>
    </metadata>
    </record>
    <session-id>YUDFBMMHHXLQ8VH742FLKJ56QHPRX5CIPT7K6DL9V6BYQPLGAB</session-id>
    </present>
    

 

Possible Error Codes

1. If the given Format (for example, test), is different from marc or marc_latin, the following error message appears in the XML output:

< error>Unsupported format test</error>

2. If the set number has not been given:

< error>Error reading set 000000</error>

3. If the set entry has not been given:

< error>Error parsing set entry</error>

4. If the given range of set entries begins with the larger number (for example, set_entry=000000003-000000001):

< error>Error parsing set entry 000000003-000000001</error>

5. If the given set entry is non-numeric (for example, aleph):

< error>Error parsing set entry aleph</error>

6. If the set number could not be found in Z05:

< error>Error reading set 000936</error>