Get Hold Requests Holds to Action List

GET /api/.../holdssummary/{branchid}/{branchtypeid}/{requeststatusid}?action=holdstoaction

Get list of held items with a Cancelled Hold Request and held items with no linked Hold Request, Unclaimed Hold Requests, and held items to transfer

GET /api/.../holdssummary/{branchid}/2/0/0?action=holdstoaction

Request Information

Name Type Required Description
branchid Integer Yes Requested branch ID
branchtypeid Integer Yes Type of branch
1 = Requesting Patron Branch
2 = Pickup Branch
3 = Filling Item Branch
requeststatusid Integer Yes Hold status ID
1 = Inactive
3 = Active
4 = Pending
5 = Shipped
6 = Held
7 = Not Supplied
8 = Unclaimed
9 = Expired
16 = Cancelled
17 = Out to patron
18 = Pulled
exclpermchk Boolean No Exclude Permission Check flag

Response Information

An HTTP return status code of 200 indicates success.

Example
application/json, text/json 
 [
    {
        "RequestID":811673,
        "BibliographicRecordID":8675,
        "ItemRecordID":692595,
        "PatronID":358215,
        "StatusDate":"2015-10-20T20:49:56.557-04:00",
        "ExpirationDate":"2015-10-30T00:00:00-04:00",
        "ActivationDate":"2015-10-20T04:00:00-04:00",
        "RequestStatusDescription":"Held",
        "PickupBranchID":null,
        "PickupBranchName":"Amsterdam Free Library",
        "PickupBranchAbbreviation":"AMS",
        "PatronBranchAbbreviation":"AMS",
        "PatronBranchName":"Amsterdam Free Library",
        "ItemBranchName":"Quaker Street-Duanesburg Branch - Schenectady Coun",
        "BrowseTitle":"Harry by the sea",
        "SortTitle":"HARRY BY THE SEA",
        "BrowseAuthor":"Zion, Gene",
        "SortAuthor":"ZION GENE",
        "PrimaryMARCTOMID":null,
        "MarcTypeOfMaterialDescription":"Book",
        "PatronFullName":"Hoyos, Norma",
        "PatronBarcode":"hoyos1019",
        "ItemBarcode":"0000410507727",
        "CallNumber":"jP Fict Zio",
        "SortCallNumber":"JP FICT ZIO",
        "CollectionName":"Children's Picture Books",
        "ShelfLocationDescription":null,
        "MaterialTypeDescription":"Book",
        "StaffDisplayNotes":"",
        "NonPublicNotes":"",
        "PACDisplayNotes":"",
        "ItemLevelHold":1,
        "BorrowByMail":0,
        "ConstituentBibRecordID":0,
        "RequestStatusID":6,
        "HasConstituentBib":false,
        "NewPickupBranchID":19,
        "TrappingItemAssignedBranchID":0,
        "DateType": 3,
        "PickupAreaDescription": "Curbside"
    }
]
Returns holds request summary data record list, for a pick list application.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.