Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Information about the ingest operation to be performed.

No Format
  <request>
    <user>ole-khuntley</user>
    <operation>batchIngest</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content>
        See section "Sample Input XML for Ingest".
    </content>
        </ingestDocument>
    </requestDocuments>
</request>

...

Information about the response from the service for the given request

No Format
  <response>
  <documents>
    	<document id="1" category="work" type="bibliographic" format="marc">
      	    <uuid>8675a422-b6ad-440e-bc0d-9f0dc1526ed2</uuid>
	</document>
   </documents>
<user>ole-khuntley</user>
<operation>batchIngest</operation>
<status>Success</status>
<message>Documents ingested</message>
</response>

...

           Information about the check in  operation to be performed     

No Format

 <request>
    <user>ole-khuntley</user>
    <operation>checkIn</operation>
    <requestDocuments>
        <ingestDocument id="5325d77a-8221-4fda-a78f-6d2f96e0b059" category="work"
                               type="bibliographic" format="marc">
            <content>
		See section "Sample Input XML for Check in".
	</content>
        </ingestDocument>
    </requestDocuments>
</request>

...

HttpResponse should be read and interpreted as given in the next section below.

2.5.4 Response XML

            Information about the response from the service for the given request 

No Format

 <?xml version="1.0" encoding="UTF-8"?>
<OLEDocstore-call>
	<request>
		<command>Check-in</command>
		<params/>
	</request>
	<response>
		<status>Success</status>
		<message>Successfully checked in </message>
	</response>
</OLEDocstore-call>

...

This operation retrieves the content of a document given its UUID.

2.6.1 Sending the request

...

                  uuid=<uuid of the document to be retrieved>

2.6.2 Receiving the response

...

2.7.1 Sending the request

URL: http://localhost:9080/oledocstore/document

...

                  requestContent=<request.xml as described in the next section>

2.7.2  Request XML

         Information about the delete  operation to be performed. The "Id" attribute of <ingestDocument> should be a valid UUID of a previously ingested document.

No Format
  <request>
    <user>ole-khuntley</user>
    <operation>delete</operation>
    <requestDocuments>
<ingestDocument id="715e92f0-b3ab-4263-96d9-58183a23e6d5"><linkedIngestDocuments></linkedIngestDocuments></ingestDocument>
 </requestDocuments>
</request>

...

             HttpResponse should be read and interpreted as given in the next section below.

2.7.4  Response XML

 Information about the response from the service for the given request.

No Format
  <response>
  <documents>
    <document id="715e92f0-b3ab-4263-96d9-58183a23e6d5"></document>
  </documents>
  <user>ole-khuntley</user>
  <operation>delete</operation>
  <status>Success</status>
</response>

...

3.0.1  Sample Input XML for Ingest

No Format
  <request>
    <user>ole-khuntley</user>
    <operation>batchIngest</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content><![CDATA[
            <collection xmlns="http://www.loc.gov/MARC21/slim">
    <record>
        <leader>01142cam 2200301 a 4500<<leader>#####nam#a22######a#4500</leader>
   
    <controlfield tag="001">92005291<>3</controlfield>
        <controlfield tag="003">DLC<>OCoLC</controlfield>
        <controlfield tag="005">19930521155141>20090213152530.9<7</controlfield>
        <controlfield tag="008">920219s1993 caua j 000 0 eng<>131031s########xxu###########000#0#eng#d</controlfield>
        <datafield tag="010035" ind1=" " ind2=" ">
            <subfield code="a">92005291<>(OCoLC)ocm62378465</subfield>
        </datafield>
        <datafield tag="020040" ind1=" " ind2=" ">
             <subfield code="a">0152038655 :<>DLC</subfield>
             <subfield code="c">$15.95<>DLC</subfield>
        </datafield>         <datafield tag="040" ind1=" " ind2=" ">
            <subfield code="a"<subfield code="d">DLC</subfield>
             <subfield code="cd">DLC<>HLS</subfield>
             <subfield code="d">DLC<>IUL</subfield>
        </datafield>
         <datafield tag="042022" ind1=" " ind2=" ">
            <subfield code="a">lcac<>1729-1070|20</subfield>
        </datafield>
        <datafield tag="050029" ind1="01" ind2="0 ">
            <subfield code="a">PS3537.A618<>AU@|b000040176476</subfield>
            <subfield code="b">A88 1993<>000040176476</subfield>
        </datafield>
        <datafield tag="082037" ind1="0 " ind2="0 ">
            <subfield code="a">811/.52</subfield>
            <subfield code="2">20<b">The Managing Editor, BIAC Journal, P.O. Box 10026, Gaborone, Botswana</subfield>
        </datafield>
        <datafield tag="100042" ind1="1 " ind2=" ">
            <subfield code="a">Sandburg, Carl,<>lc</subfield>
            <subfield code="d">1878-1967.</subfield>
        </datafield>
        <datafield tag="245043" ind1="1" ind2="0">
            <subfield code="a">Arithmetic /<>f-bs---</subfield>
        </datafield>
   <subfield code="c">    <datafield tag="050" ind1="0" ind2="0">
         Carl Sandburg ; illustrated as an anamorphic adventure by Ted Rand.
            <<subfield code="a">HD70.B55|bB53</subfield>
        </datafield>
        <datafield tag="250049" ind1=" " ind2=" ">
            <subfield code="a">1st ed.<>IULA</subfield>
        </datafield>
         <datafield tag="260210" ind1=" 1" ind2=" ">
            <subfield code="a">San Diego :>BIAC j.</subfield>
        </datafield>
        <subfield <datafield codetag="b222" ind1=">Harcourt Brace Jovanovich,</subfield>" ind2="0">
            <subfield code="c">c1993.<a">BIAC journal</subfield>
        </datafield>
         <datafield tag="300245" ind1=" 0" ind2=" 0">
            <subfield code="a">1 v>The administration of justice. (unpaged) :<BIAC journal</subfield>
        </datafield>
      <subfield code="b">ill. (some col.) ;</subfield>   <datafield tag="246" ind1="1" ind2="3">
            <subfield code="c">26 cm.<a">Botswana Institute of Administration and Commerce journal</subfield>
        </datafield>
        <datafield tag="500260" ind1=" " ind2=" ">
            <subfield code="a">One Mylar sheet included in pocket.<>Gaborone, Botswana :|bBotswana Institute of Administration and Commerce</subfield>
        </datafield>         <subfield code="b">Botswana Institute of Administration and Commerce</subfield>
        </datafield>
        <datafield tag="520300" ind1=" " ind2=" ">
            <subfield code="a">
>v. ;</subfield>
            <subfield code="c">24 cm.</subfield>
A poem about numbers and their characteristics. Features anamorphic,</datafield>
or distorted,       <datafield tag="300" ind1=" " ind2=" ">
    drawings which can be     <subfield code="a">v. ;</subfield>
         restored to normal by viewing from a particular angle or by viewing the image's
<subfield code="c">24 cm.</subfield>
        </datafield>
        <datafield tag="300" ind1=" " ind2=" ">
 reflection in the         <subfield code="a">v. ;</subfield>
     provided Mylar cone.     <subfield        code="c">24 cm.</subfield>
        </datafield>
        <datafield tag="650310" ind1=" " ind2="0 ">
            <subfield code="a">Arithmetic</subfield>
            <subfield code="x">Juvenile poetry.<>Semiannual</subfield>
        </datafield>
        <datafield tag="650362" ind1=" 1" ind2="0 ">
            <subfield code="a">Children's poetry, American> Began in 2004.</subfield>
        </datafield>
        <datafield tag="650500" ind1=" " ind2="1 ">
            <subfield code="a">Arithmetic</subfield>>Description based on: Vol. 1, no. 1 (May. 2004); title from cover.</subfield>
        </datafield>
        <datafield tag="500" ind1=" " ind2=" ">
            <subfield code="x">Poetry.</subfield>a">Latest issue consulted: Vol. 3, no. 1 (May 2006).</subfield>
        </datafield>
        <datafield tag="650" ind1="0" ind2=" ">
            <subfield code="a">Industrial management</subfield>
            <subfield code="z">Botswana</subfield>
            <subfield code="v">Periodicals.</subfield>
        </datafield>
        <datafield tag="650" ind1="0" ind2=" ">
            <subfield code="a">Occupational training</subfield>
            <subfield code="z">Botswana</subfield>
            <subfield code="v">Periodicals.</subfield>
        </datafield>
        <datafield tag="710" ind1="2" ind2=" ">
            <subfield code="a">Botswana Institute of Administration and Commerce.</subfield>
        </datafield>
        <datafield tag="850" ind1=" " ind2=" ">
            <subfield code="a">DLC</subfield>
        </datafield>
        <datafield tag="891" ind1="2" ind2="0">
            <subfield code="a">9853|81.1</subfield>
            <subfield code="a">v.</subfield>
            <subfield code="b">no</subfield>
            <subfield code="u">2</subfield>
            <subfield code="v">r</subfield>
            <subfield code="i">(year)</subfield>
            <subfield code="j">(month)</subfield>
            <subfield code="w">f</subfield>
            <subfield code="x">05</subfield>
        </datafield>
        <datafield tag="891" ind1="4" ind2="1">
            <subfield code="a">9863|81.1</subfield>
            <subfield code="a">1</subfield>
            <subfield code="b">1</subfield>
            <subfield code="i">2004</subfield>
            <subfield code="j">05</subfield>
        </datafield>
        <datafield tag="596" ind1=" " ind2=" ">
            <subfield code="a">1</subfield>
        </datafield>
    </record>
</collection>
                ]]>
            </content>
            <!--optional -->
            <additionalAttributes>
                <dateEntered></dateEntered>
                <lastUpdated></lastUpdated>
             </datafield>   <fastAddFlag></fastAddFlag>
     <datafield tag="650" ind1=" " ind2="1">       <supressFromPublic></supressFromPublic>
     <subfield code="a">American poetry.</subfield>         <<harvestable></datafield>harvestable>
          <datafield tag="650" ind1=" " ind2="1">  <status></status>
          <subfield code="a">Visual perception.</subfield>     <createdBy></createdBy>
     </datafield>         <datafield tag="700" ind1="1" ind2=" "> <updatedBy></updatedBy>
              <subfield code="a">Rand, Ted,</subfield> <statusUpdatedOn></statusUpdatedOn>
             <subfield code="e">ill.</subfield>  <statusUpdatedBy></statusUpdatedBy>
      </datafield>     </record> </collection>    <staffOnlyFlag>true</staffOnlyFlag>
            ]]></additionalAttributes>
            <<linkedIngestDocuments></content>linkedIngestDocuments>
        </ingestDocument>

    </requestDocuments>
</request>



3.0.2  Sample Input file for Check In

The "Id" attribute of <ingestDocument> should be a valid UUID of a previously ingested document.

No Format

 <request>
    <user>ole-khuntley</user>
    <operation>checkIn</operation>
    <requestDocuments>
        <ingestDocument id="1" category="work" type="bibliographic" format="marc">
            <content><![CDATA[
<collection xmlns="http://www.loc.gov/MARC21/slim">
    <record>
        <leader>01142cam 2200301 a 4500</leader>
        <controlfield tag="001">92005291</controlfield>
        <controlfield tag="003">DLC</controlfield>
        <controlfield tag="005">19930521155141.9</controlfield>
        <controlfield tag="008">920219s1993 caua j 000 0 eng</controlfield>
        <datafield tag="010" ind1=" " ind2=" ">
            <subfield code="a">92005291</subfield>
        </datafield>
        <datafield tag="020" ind1=" " ind2=" ">
            <subfield code="a">0152038655 :</subfield>
            <subfield code="c">$15.95</subfield>
        </datafield>
        <datafield tag="040" ind1=" " ind2=" ">
            <subfield code="a">DLC</subfield>
            <subfield code="c">DLC</subfield>
            <subfield code="d">DLC</subfield>
        </datafield>
        <datafield tag="042" ind1=" " ind2=" ">
            <subfield code="a">lcac</subfield>
        </datafield>
        <datafield tag="050" ind1="0" ind2="0">
            <subfield code="a">PS3537.A618</subfield>
            <subfield code="b">A88 1993</subfield>
        </datafield>
        <datafield tag="082" ind1="0" ind2="0">
            <subfield code="a">811/.52</subfield>
            <subfield code="2">20</subfield>
        </datafield>
        <datafield tag="100" ind1="1" ind2=" ">
            <subfield code="a">Sandburg, Carl,</subfield>
            <subfield code="d">1878-1967.</subfield>
        </datafield>
        <datafield tag="245" ind1="1" ind2="0">
            <subfield code="a">Arithmetic /</subfield>
            <subfield code="c">
                Carl Sandburg ; illustrated as an anamorphic adventure by Ted Rand.
            </subfield>
        </datafield>
        <datafield tag="250" ind1=" " ind2=" ">
            <subfield code="a">1st ed.</subfield>
        </datafield>

    </record>
</collection>
                ]]>
            </content>
        </ingestDocument>
    </requestDocuments>
</request>

...