Get list of hold requests for request manager application

GET /api/.../requestmanager/{branchid}/{branchtypeid}/{holdstatusid}?illrequests=false&innReachRequest=false&heldtotransfer=false

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
holdstatusid 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
Ill Status ID
1 = Inactive
3 = Active
5 = Shipped
10 = Received-Held
11 = Received-Transferred
12 = Received-Satisfied
13 = Received-Used
14 = Received-Unused
15 = Returned
16 = Cancelled
illrequests boolean No Define this parameter in the request query string to get the ILL requests.
innReachRequest boolean No Define this parameter in the request query string to get the INNReach requests.
heldtotransfer boolean No Define this parameter in the request query string to get the held items to transfer

Response Information

An HTTP return status code of 200 indicates success.

Example Local requests Response
application/json, text/json 
 [
    {
    "RequestType":0,
    "RequestID":806939,
    "BibliographicRecordID":0,
    "ItemRecordID":null,
    "PatronID":0,
    "StatusDate":null,
    "ExpirationDate":null,
    "ActivationDate":null,
    "RequestStatusDescription":null,
    "PickupBranchID":92,
    "PickupBranchName":null,
    "PickupBranchAbbreviation":"SCP",
    "PatronBranchName":null,
    "PatronBranchAbbreviation":null,"ItemBranchName":null,
    "BrowseTitle":"Journal - Western New York Genealogical Society. Vol 5  (Nov. 27 2009)",
    "SortTitle":null,
    "BrowseAuthor":"Western New York Genealogical Society.","SortAuthor":null,
    "PrimaryMARCTOMID":null,
    "MarcTypeOfMaterialDescription":null,
    "PatronFullName":"Oliver, Niklas E",
    "PatronBarcode":null,
    "ItemBarcode":"nbvcty",
    "CallNumber":"Fict 3 4 5 7",
    "SortCallNumber":null,
    "CollectionName":null,
    "ShelfLocationDescription":null,
    "MaterialTypeDescription":"Serial",
    "StaffDisplayNotes":null,
    "NonPublicNotes":null,
    "PACDisplayNotes":null,
    "ItemLevelHold":0,
    "BorrowByMail":0,
    "ConstituentBibRecordID":0,
    "RequestStatusID":17,
    "HasConstituentBib":false,
    "NewPickupBranchID":null,
    "InnReachType":0,
    "PatronBranchID":null,
    "PatronExpirationDate":null,
    "PatronAddrCheckDate":null,
    "TrappingItemAssignedBranchID":null,
    "ItemBranchAbbreviation":null,
    "ItemCheckoutDate":"2012-01-03T11:40:41.057-05:00",
    "ItemDueDate":"2012-01-28T23:59:00-05:00",
    "SortAuthor":"WESTERN NEW YORK GENEALOGICAL SOCIETY",
    "SortTitle":"JOURNAL WESTERN NEW YORK GENEALOGICAL SOCIETY",
    "ItemStatusDescription": "",
    "INNReachPickupBranch":"",
    "PickupAreaDescription": null
    }
]
Returns holds request summary data record list, for a request manager application.
Example ILL requests Response
application/json, text/json 
[
    {
        "ILLRequestID":897633,
        "ILLStatusID":5,
        "PatronID":263571,
        "ItemRecordID":0,
        "BibRecordID":0,
        "PickupLibID":92,
        "CreationDate":"2019-04-29T00:00:00-04:00",
        "ILLStatusDescription":"Shipped",
        "Author":"Shreve, Susan",
        "Title":"Warts / by Susan Shreve ; illustrated by Gregg Thorkelson.",
        "FormatDescription":"Book",
        "ItemStatusID":null,
        "ItemStatusDescription":"",
        "StatusDate":null,
        "PatronName":"Swain, Alexandra M",
        "PatronBranch":"SCP",
        "ItemAssignedBranchAbbr":"",
        "PickupBranchAbbr":"SCP",
        "ShippedDate":"2019-04-30T00:00:00-04:00",
        "SortAuthor":"SHREVE SUSAN",
        "SortTitle":"WARTS BY SUSAN SHREVE ILLUSTRATED BY GREGG THORKELSON",
        "INNReachItemAgencyCode":"plagc",
        "INNReachItemLocation":"Item's Location"
    },
    {
        "ILLRequestID":897635,
        "ILLStatusID":5,
        "PatronID":263571,
        "ItemRecordID":0,
        "BibRecordID":0,
        "PickupLibID":92,
        "CreationDate":"2019-04-29T00:00:00-04:00",
        "ILLStatusDescription":"Shipped",
        "Author":"Haley, Amanda.",
        "Title":"It's a baby's world / by Amanda Haley.",
        "FormatDescription":"Book",
        "ItemStatusID":null,
        "ItemStatusDescription":"",
        "StatusDate":null,
        "PatronName":"Swain, Alexandra M",
        "PatronBranch":"SCP",
        "ItemAssignedBranchAbbr":"",
        "PickupBranchAbbr":"SCP",
        "ShippedDate":"2019-04-29T00:00:00-04:00",
        "SortAuthor":"HALEY AMANDA",
        "SortTitle":"ITS A BABYS WORLD BY AMANDA HALEY",
        "INNReachItemAgencyCode":"plagd",
        "INNReachItemLocation":""
    }
]
Returns ILL request summary data record list, for a request manager application.

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
Example GET
Local requests
  • Active requests by patron branch: GET /api/.../requestmanager/3/1/3
  • Active requests by pick up branch:GET /api/.../requestmanager/3/2/3
  • Held requests by patron branch:GET /api/.../requestmanager/3/1/6
  • Held requests by pick up branch:GET /api/.../requestmanager/3/2/6
  • Held requests by Item:GET /api/.../requestmanager/3/3/6
Ill requests
  • Active ILLs by patron branch: GET /api/.../requestmanager/3/1/3?illrequests=true
  • Active ILLs by pick up branch:GET /api/.../requestmanager/3/2/3?illrequests=true
  • Returned ILLs by Item:GET /api/.../requestmanager/3/3/15?illrequests=true

Permissions

               
  LOCAL:        AccessCirculationControl_Allow
                AccessILLRequestManager_Allow       
             
  ILL:          AccessCirculationControl_Allow
                AccessHoldRequestManager_Allow