Update Local Hold Request

PUT /api/.../holds/{id}

Update a local hold request.

If the supplied PickupBranchID is different than the one currently assigned to the hold request, the 'Set Pickup Branch' API is automatically called as part of the update. See the API documentation for 'Set Pickup Branch' for additional errors that may be thrown.

Request Information

{id} is the primary key of the hold request record. It is required.

POST Form Data

Provide the following in the form/body of the request:

Name Type Required Description
PickupBranchID Integer Yes
ActiviationDate DateTime Yes
ExpirationDate DateTime Yes
HoldTillDate DateTime No
StaffDisplayNotes String No
NonPublicNotes String No
PACDisplayNotes String No
BorrowByMail Boolean No
TrackingNumber String No

Response Information

'true' on successful update.

Example
application/json, text/json 
1000

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Update data not provided in body of request.
404 FAILURE. Hold Request not found. Incorrect or no ID provided.
409 FAILURE.
  • Object not locked
  • Object locked by another user
409 CONFLICT. Patron record is secured.

Required Permissions

Permission IDs found here.

    HoldRequests_Modify (based on the pickup branch ID)