Batch Update ILL Requests
POST /api/.../illrequests/batch
Update pickup branch, pickup area, and/or hold till date for multiple ILL requests in a single call.
Request Information
DtoILLBatchUpdate
| Property |
Type |
Nullable |
Description |
| ILLRequestIDs |
List<int> |
No |
List of ILL request IDs to update. |
| Update |
DtoILLUpdate |
No |
Update values to apply to each ILL request in ILLRequestIDs. |
DtoILLUpdate
| Property |
Type |
Nullable |
Description |
| PickupBranchID |
Integer |
Yes |
Pickup branch ID for updated ILL requests. If null, branch is not changed. |
| PickupAreaID |
Integer |
Yes |
Pickup area ID for updated ILL requests. If null, area is not changed. |
| HoldTillDate |
DateTime |
Yes |
Hold till date for updated ILL requests. If null, date is not changed. |
Example
application/json, text/json
{
ILLRequestIDs: [12345, 12346, 12347],
Update:
{
PickupBranchID: 10,
PickupAreaID: 4,
HoldTillDate: "3/24/2026"
}
}
Response Information
HoldsBatchUpdateResult
| Property |
Type |
Nullable |
Description |
| SuccessfulUpdates |
Integer |
No |
Number of ILL requests updated successfully. |
| FailedUpdates |
Integer |
No |
Number of ILL requests that failed to update. |
| ErrorMessages |
List<string> |
No |
Failure messages returned by workflow processing. |
Example
application/json, text/json
{
SuccessfulUpdates: 2,
FailedUpdates: 1,
ErrorMessages:
[
"Patron is blocked."
]
}
HTTP Response Codes
| Code |
Description |
| 200 |
OK. Request processed. |
| 400 |
FAILURE. Validation or processing error. |
Required Permissions
Bulk Change Hold Requests - Allow