Get Hold Request Summary List

GET /api/.../holdssummary/{branchid}/{branchtypeid}/{requeststatusid}?collectionlist={collectionlist}&shelflocationlist={shelflocationlist}

Get a local hold summary list.

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 Mranch
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

Response Information

An HTTP return status code of 200 indicates success.

Example
application/json, text/json
 [
    {
        "RequestID":811072,
        "BibliographicRecordID":25200,
        "ItemRecordID":451081,
        "PatronID":52324,
        "StatusDate":"2013-09-13T05:00:22.5",
        "ExpirationDate":"2013-10-06T23:59:59",
        "ActivationDate":"2013-07-08T00:00:00",
        "RequestStatusDescription":"Pending",
        "PickupBranchName":"Cambridge Public Library",
        "PatronBranchName":"Crandall Public Library (Glens Falls)",
        "ItemBranchName":"Schenectady County Public Library - Central",
        "BrowseTitle":"The cat's whisker : 50 years of wireless design",
        "SortTitle":"CATS WHISKER 02(50)99 YEARS OF WIRELESS DESIGN",
        "BrowseAuthor":"Hill, Jonathan.",
        "SortAuthor":"HILL JONATHAN",
        "MarcTypeOfMaterialDescription":"Book",
        "PatronFullName":"Batson, Billy",
        "PatronBarcode":"1000500534226",
        "ItemBarcode":"0000405396847",
        "CallNumber":"621.3841 H64 Oversize",
        "SortCallNumber":"0000000621.3841 H64 OVERSIZE",
        "CollectionName":"Adult Nonfiction",
        "ShelfLocationDescription":null,
        "MaterialTypeDescription":"Book",
        "StaffDisplayNotes":null,
        "NonPublicNotes":null,
        "PACDisplayNotes":null
        "ItemLevelHold": 0,
		"BorrowByMail": 0,
		"ConstituentBibRecordID":null
    },
    {
        "RequestID":811347,
        "BibliographicRecordID":3878,
        "ItemRecordID":311039,"
        PatronID":356950,
        "StatusDate":"2013-09-10T05:00:09.597",
        "ExpirationDate":"2013-09-19T23:59:59",
        "ActivationDate":"2013-09-09T00:00:00",
        "RequestStatusDescription":"Pending",
        "PickupBranchName":"Amsterdam Free Library",
        "PatronBranchName":"Schenectady County Public Library - Central",
        "ItemBranchName":"Schenectady County Public Library - Central",
        "BrowseTitle":"Africa since 1875 : a modern history",
        "SortTitle":"AFRICA SINCE 04(1875)99 A MODERN HISTORY",
        "BrowseAuthor":"Hallett, Robin.",
        "SortAuthor":"HALLETT ROBIN",
        "MarcTypeOfMaterialDescription":"Book",
        "PatronFullName":"Phelps, Mary Catherine",
        "PatronBarcode":"21234000002105",
        "ItemBarcode":"0000400706891",
        "CallNumber":"960 H18af",
        "SortCallNumber":"0000000960 H18AF",
        "CollectionName":"Adult Nonfiction",
        "ShelfLocationDescription":null,
        "MaterialTypeDescription":"Book",
        "StaffDisplayNotes":"Outreach Services Patron",
        "NonPublicNotes":null,
        "PACDisplayNotes":null
        "ItemLevelHold": 0,
		"BorrowByMail": 0,
		"ConstituentBibRecordID":null
    }
 ]
Returns holds request summary data record list, for a pick list application.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.