OCLC Developer Network

Receiving Purchase order Copies

Please note:

  • "Receive" is a virtual resource which cannot be read. You can only read the copy resource.
  • When you "receive" a copy you can modify the details of that copy.

To recieve copy item, construct the URL in the following manner:

https://acq.sd00.worldcat.org/purchaseorders/{orderNumber}/items/{orderItemNumber}/copies/{copyNumber}/receive?inst={institutionId}

Examples:

Below are some sample URLs and an explanation of what they are querying using different HTTP methods:

EXAMPLE URLHTTP METHODNOTES
https://acq.sd00.worldcat.org/purchaseorders/PO-2011-11/items/OIN-2011-31/copies/1/recievePUTWill update an existing purchase order copy inside Order Item OIN-2011-31 in the purchase order with ID PO-2011-11 if properly structured XML is attached to the request. 
https://acq.sd00.worldcat.org/purchaseorders/PO-2011-11/items/OIN-2011-31/copies/1/recievePOSTWill create a new purchase order copy inside Order Item OIN-2011-31 in the purchase order with ID PO-2011-11 if properly structured XML is attached to the request. 

 

XML structure for POST and PUT requests:

More information about the proper structure of XML made as part of POST and PUT requests can be found here:

Below are two XML payload examples for recieving a purchase order item:

Creating a purchase order copy:

<?xml version="1.0" ?>
<entry xmlns="http://www.w3.org/2005/Atom">
  <content type="application/xml">
    <copyReceipt xmlns="http://worldcat.org/xmlschemas/purchase-order/CopyReceipt-1.3" xmlns:ns2="http://worldcat.org/xmlschemas/purchase-order/Copy-1.3" xmlns:ns3="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrderItem-1.3" xmlns:ns4="http://worldcat.org/xmlschemas/purchase-order/Resource-1.3" xmlns:ns5="http://worldcat.org/xmlschemas/purchase-order/CopyConfig-1.3" xmlns:ns6="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrder-1.3" xmlns:ns7="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrderSubmission-1.3"/>
  </content>
</entry>

Updating a purchase order copy:

<entry xmlns="http://www.w3.org/2005/Atom"><content type="application/xml"><copyReceipt xmlns="http://worldcat.org/xmlschemas/purchase-order/CopyReceipt-1.3" xmlns:ns2="http://worldcat.org/xmlschemas/purchase-order/Copy-1.3" xmlns:ns4="http://worldcat.org/xmlschemas/purchase-order/Resource-1.3" xmlns:ns3="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrderItem-1.3" xmlns:ns5="http://worldcat.org/xmlschemas/purchase-order/CopyConfig-1.3" xmlns:ns6="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrder-1.3" xmlns:ns7="http://worldcat.org/xmlschemas/purchase-order/PurchaseOrderSubmission-1.3">
    <createLocalHoldingsRecord>true</createLocalHoldingsRecord>
    <copy>
        <ns2:copyNumber>3</ns2:copyNumber>
        <ns2:barcode>MyBarcode-553805673</ns2:barcode>
        <ns2:branchId>125575</ns2:branchId>
        <ns2:shelvingLocationId>Tyler's Shelving Location</ns2:shelvingLocationId>
        <ns2:shelvingScheme>LIBRARY_OF_CONGRESS</ns2:shelvingScheme>
        <ns2:callNumber>call</ns2:callNumber>
        <ns2:itemCopyId>0</ns2:itemCopyId>
        <ns2:itemCopyNumber>0</ns2:itemCopyNumber>
        <ns2:status>DUE</ns2:status>
    </copy>
</copyReceipt></content></entry>

Follow the OCLC Developer Network:

The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »

© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates


Powered by Drupal, an open source content management system