Hold Queues

Get Hold Queue Entries

GET /api/.../holdqueues/{bibliographicRecordID}/entries?designationFilter={designationFilter}&volumeFilter={volumeFilter}&constituentBibRecordID={constituentBibRecordID}&allRequests={true/false}

Return hold queue entries for a given bibliographic record.

Parameters
Name Type Required Description
bibliographicRecordID Integer Yes The unique id assigned to the bibliographic record.
designationFilter String No The designation filter.
volumeFilter String No The volume filter.
constituentBibRecordID Integer No The unique id assigned to the constituent bibliographic record.
allRequests Boolean No When true will return all requests associated with the provided bibliographic record regardless of hold status.

Response Information

Example
application/json, text/json 
[
    {
        "SysHoldRequestID":440342,
        "SysHoldStatusID":3,
        "PatronFullName":"Peacock, Shirley",
        "PatronBranchName":"Minden",
        "HoldStatusName":"Active",
        "PickupBranchName":"Inventory",
        "VolumeNumber":null,
        "Designation":null,
        "CreationDate":"2014-10-29T17:38:00.51-04:00",
        "ExpirationDate":"2015-10-14T23:59:59-04:00",
        "PickupBranchID":83,"ItemLevelHold":false,
        "BorrowByMailRequest":false,
        "HasConstituentBib":false,
        "TotalRequestCount":1,
        "PatronID":785645,
        "InnReachType":0
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request
404 Invalid bibliographic record ID