Pull List Resource

URLs and Supported Requests

The Pull List supports one operation.

Operation Resource URL HTTP METHOD
Read https://{registryID}.share.worldcat.org/circ/pulllist/{branchId} GET

HTTP Accept Types

The Pull List service can return data in two possible formats. The default format is application/atom+json. To get the results in different formats it is necessary to perform content negotiation. 

Parameters

The table below lists the optional parameters that can be used as part of the Pull List resource:

Parameter Required Notes
startIndex No What index item to start the collection at
itemsPerPage No How many collection items to turn per request

Pull list Item Fields

Name Restrictions
Description LHR Field/subfield
bibliographicItem   bibliographic details
 
pieceDesignation
  barcode of the item
852 $p
callNumber      
callNumber/shelvingScheme     852 first indicator
callNumber/shelvingInformation     852 $h
callNumber/itemParts    

852 $i


callNumber/prefixes
    852 $k
callNumber/suffixes
    852 $m
callNumber/description   The call number as displayed in Staff UI
 
recordType

SINGLE_PART

MULTI_PART

SERIAL

UNKNOWN

   
holdingInformation      

holdingInformation/captionId
     

holdingInformation/enumeration
    863-865 $a - $h
holdingInformation/chronology
    863-865 $i, $j, $k, $l, $m, $v
holdingInformation/description     866-868 $a
numberOfPieces      
physicalDescription      
cost     876-878 $c
homeHoldingLocation     852 $b
permanentShelvingLocation     852 $c
previousShelvingLocation     852 $d
temporaryShelvingLocation     876-878 $l
publicNotes     876-878 $z
staffNotes     876-878 $x
useRestrictions
    876-878 $h
requestDate   Date of the request
 
patronName   Name of the requesting patron
 
enumeration      
freeText      
requestId   Request ID
 
pullReason      
lastPrintedDate      
forward      
scheduleStartDate      
scheduleEndDate      
pickupLocationName      
ownerInstitutionId      
restrictedLocations      

restrictedLocations/institution
     
restrictedLocations/holdingLocation      
restrictedLocations/shelvingLocation
     
itemType

LHR

TEMPORARY

FREE_TEXT

CONTAINER

Describes the type of item on the pull list.  
requestSource   Information on the source of the request that requires the item to be pulled.
 
requestSource/externalRequestSystem      
requestSource/externalRequestId
     
requestSource/externalRequestRole      
requestSource/externalRequestInstitution      

Example URLs

Returns information about a specific pulllist from the branch with ID 129479:

https://128807.share.worldcat.org/circ/pulllist/129479

Notes