OCLC Developer Network

Copy request

 

Building a query:

To access a collection of copies or local holdings record construct the URL in the following manner:

https://circ.sd00.worldcat.org/LHR?{query}

To access information on a specific copy or local holdings record construct the URL in the following manner::

https://circ.sd00.worldcat.org/LHR/{copyId}

where {query} or {copyId} provide information about the copy or local holdings record you are requesting information for.

 

Examples:

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

EXAMPLE URLHTTP METHODNOTES
https://circ.sd00.worldcat.org/LHR/55171589GETReturns information about a specific copy or local holdings record where the ID matches 55171589.
https://circ.sd00.worldcat.org/LHR?q=oclc:33242178GETReturns a collection of copies of local holdings records where the OCLC number of items match 33242178.
https://circ.sd00.worldcat.org/LHR/55171589PUTWill update a specific copy or local holdings record with ID 55171589 if properly structured XML is attached to the request.
https://circ.sd00.worldcat.org/LHR/55171589DELETEWill delete a specific copy or local holdings record with ID 55171589.
https://circ.sd00.worldcat.org/LHRPOSTWill create a new copy of local holdings records if properly strcutured 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 creating and updating a purchase order:

Creating a copy or local holdings record:

<?xml version='1.0' encoding='UTF-8'?>
  <entry  xmlns='http://www.w3.org/2005/Atom' xmlns:os='http://a9.com/-/spec/opensearch/1.1/' xmlns:gd='http://schemas.google.com/g/2005'>
    <title type='text' />
    <updated>2011-10-07T13:57:43.537Z</updated>
    <content type='application/xml'>
      <copy xmlns='http://worldcat.org/xmlschemas/Copy-1.0' id='https://circ.sd00.worldcat.org/LHR/55171589'>
        <institution>http://www.worldcat.org/webservices/registry/content/Institutions/1</institution>
        <bib>urn:oclc:platform/bibs/33252178</bib>
        <recordType>SERIAL</recordType>
        <receiptStatus>UNKNOWN</receiptStatus>
        <holdingLocation>WAUA</holdingLocation>
        <shelvingLocation>Periodicals</shelvingLocation>
        <shelvingDesignation scheme='UNKNOWN'>
          <information>call</information>
          <itemPart>number</itemPart>
        </shelvingDesignation>
        <holding category='BASIC'>
          <pieceDesignation>64849398475859a</pieceDesignation>
          <caption sequence='1' id='1'>
            <enumeration label='v.'>1</enumeration>
            <enumeration label='no.'>1</enumeration>
            <chronology label='(year)'>2010</chronology>
            <chronology label='(month)'>8</chronology>
          </caption>
        </holding>
        <holding category='BASIC'>
          <pieceDesignation>8741298741209a</pieceDesignation>
          <caption sequence='2' id='1'>
            <enumeration label='v.'>1</enumeration>
            <enumeration label='no.'>2</enumeration>
            <chronology label='(year)'>2010</chronology>
            <chronology label='(month)'>9</chronology>
          </caption>
        </holding>
        <holding category='BASIC'>
          <pieceDesignation>8654323456543a</pieceDesignation>
          <caption sequence='1' id='2'>
            <enumeration label='no.'>10</enumeration>
          </caption>
                  <note type='STAFF'>Back cover missing</note>
                  <cost>
                    <currency>USD</currency>
                        <amount>1000</amount>
                        <qualifier>Replacement cost</qualifier>
                  </cost>
        </holding>
      </copy>
    </content>
  </entry>

If the request is successful, the response will will return newly created copy of local holdings record (with generated ID). 

Updating a copy or local holdings record:

<?xml version='1.0' encoding='UTF-8'?>
  <entry  xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/" xmlns:gd="http://schemas.google.com/g/2005">
    <title type="text" />
    <updated>2011-10-07T13:57:43.537Z</updated>
    <content type="application/xml">
      <copy xmlns="http://worldcat.org/xmlschemas/Copy-1.0" id="https://circ.sd00.worldcat.org/LHR/55171589">
        <institution>http://www.worldcat.org/webservices/registry/content/Institutions/1</institution>
        <bib>urn:oclc:platform/bibs/33252178</bib>
        <lastUpdateDate>2011-04-13T08:11:58.100Z</lastUpdateDate>
        <recordType>SERIAL</recordType>
        <receiptStatus>UNKNOWN</receiptStatus>
        <holdingLocation>WAUA</holdingLocation>
        <shelvingLocation>Periodicals</shelvingLocation>
        <shelvingDesignation scheme="UNKNOWN">
          <information>call</information>
          <itemPart>number</itemPart>
        </shelvingDesignation>
        <holding category="BASIC">
          <pieceDesignation>64849398475859</pieceDesignation>
          <caption sequence="1" id="1">
            <enumeration label="v.">1</enumeration>
            <enumeration label="no.">1</enumeration>
            <chronology label="(year)">2010</chronology>
            <chronology label="(month)">8</chronology>
          </caption>
        </holding>
        <holding category="BASIC">
          <pieceDesignation>8741298741209</pieceDesignation>
          <caption sequence="2" id="1">
            <enumeration label="v.">1</enumeration>
            <enumeration label="no.">2</enumeration>
            <chronology label="(year)">2010</chronology>
            <chronology label="(month)">9</chronology>
          </caption>
        </holding>
        <holding category="BASIC">
          <pieceDesignation>8654323456543</pieceDesignation>
          <caption sequence="1" id="2">
            <enumeration label="no.">10</enumeration>
          </caption>
          <note type="STAFF">Back cover missing</note>
          <cost>
            <currency>USD</currency>
              <amount>1000</amount>
              <qualifier>Replacement cost</qualifier>
          </cost>
        </holding>
      </copy>
    </content>
  </entry>

 

 

Query options:

Below is a list of all the possible parameters that can be used as part of the copy resource, all of them are optional:

PARAMETERDESCRIPTION
qAvailable parameters are: oclc or barcode. The values for these parameters must either be an OCLC number of barcode number respectively.
startIndexWhat index item to start the collection at.
itemsPerPageHow many collection items to return per request.
 

 

Allowed POST/PUT Values:

Below is a table listing all the allowed values and content of each data type in the Collection Management Schema, this should be used as a quick reference into required attributes and values, however a more in depth details can be found using the accompanying XSD file.

NameRequired attributes and elementsRestrictionsMay containDescription
recordType 

SINGLE_PART

MULTI_PART

SERIAL

UNKNOWN

 The characteristics and definitions of the components of the record.
receiptStatus 

ON_ORDER

CURRENTLY_RECEIVED

NOT_CURRENTLY_RECEIVED

RECEIVED_AND_COMPLETE_OR_CEASED

OTHER_RECEIPT_OR_ACQUISITIONS_STATUS

UNKNOWN

 Indicates the current receipt or acquisitions status of a copy (008/06).
noteVisibilityType 

PUBLIC

STAFF

 Enumeration of the types of note describing an item.
noteType(attr:noteVisibilityType) type:  A user defined note that can be attached to a copy or an individual holding.
holdingLocationType String that must match pattern "[A-Z]{4}" Represents a holding location. OCLC cataloguing rules require that the holding location is a single 4-character code. Corresponds to 852$b.
shelvingDesignationType(attr:shelvingSchemeType) scheme 

(string) prefix

(string) information

(string) itemPart

(string) suffix

The designation used as the shelving scheme for an item. The value of the shelving scheme determines which fields are used.
itemCategoryType 

BASIC

SUPPLEMENTARY_MATERIAL

INDEX

 The different categories of material for items.
pieceDesignationType String that must match pattern "[^BU].*" Represents the institution-defined piece designation for an item. This is the "barcode". It should not start with either a capital 'B' or 'U'.
currencyType String that must match pattern "[A-Z]{3}" The ISO 4217 currency code for representing the currency of a monetary amount. Categorised by 3 capital letters. The current valid 3-letter codes can be found at http://www.bsi-global.com
costType  

(currencyType) currency

(nonNegativeInteger) amount

(string) qualifier

A cost associated with an item, such as the original purchase price, or the amount to bill a patron if the item is lost.
captionEntryType(attr:string) label  The label and value pair for a caption describing a numeric, alphabetic, and/or date designation for an item. The label is defined as an attribute on the element and the value for the label is defined by the element contents.
captionType  

(string) description

(captionEntryType) enumeration

(captionEntryType) chronology

(nonNegativeInteger) id

(nonNegativeInteger) sequence

A set of alphanumeric or date labels (i.e. enumeration and chronology) for an item. Also includes free-text version when standard enumeration and chronology cannot be used to adequately describe the item.
holdingType(attr:itemCategoryType) category 

(pieceDesignationType) pieceDesignation

(noteType) note

(string) useRestriction

(costType) cost

(string) temporaryLocation

(captionType) caption

The information relating to a particular holding associated with a copy.
copyType  

(anyURI) institution

(anyURI) bib

(dateTime) lastUpdateDate

(recordType) recordType

(receiptStatusType) receiptStatus

(integer) copyNumber

(noteType) note

(holdingLocationType) holdingLocation

(string) shelvingLocation

(string) previousShelvingLocation

(shelvingDesignationType) shelvingDesignation

(holdingType) holding

(anyURI) id

A specific instance within a library collection of a bibliographic description. May consist of multiple items in the case of multi-volume sets and series.

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