Update Hold Request

Start Update Hold Request Process

POST /api/.../workflow

This method allows the caller to update an existing hold request.

Request Information

Parameters
Name Type Required Description
WorkflowRequest DtoWorkflowRequest Yes Define this parameter in the request body.
DtoWorkflowRequest
Property Type Nullable Description
WorkflowRequestType Int No Required. For update hold request, this must be set to 21.
TxnBranchID Int No Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch, but in the case of offline processing it would be the branch that was logged into during offline processing.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user, but in the case of offline processing it would be the user that was logged on during offline processing.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation, but in the case of offline processing it would be the workstation that was logged into during offline processing.
RequestExtension DtoWorkflowRequestExtension No To update hold request requires a UpdateHoldRequestExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
UpdateHoldRequestExtensionData
Property Type Nullable Description
WorkflowRequestExtensionType Int No For an update hold request, the extension type must be a 17 (UpdateHoldRequestData).
Data Object No This must be an extension data object of type DtoUpdateHoldRequestExtensionData
DtoUpdateHoldRequestExtensionData
Property Type Nullable Description
SysHoldRequestID Integer No Primary key. Used to update hold request.
PickupBranchID Integer No
SysHoldStatusID Integer Yes
ActivationDate DateTime Yes
ExpirationDate DateTime Yes
HoldTillDate DateTime Yes
ItemRecordID Int Yes
ItemStatusID Int Yes
ItemLevelHold Boolean Yes
StaffDisplayNotes String Yes
NonPublicNotes String Yes
PatronNotes String Yes
PACDisplayNotes String Yes
BorrowByMail Boolean Yes
TrackingNumber String Yes

Hold Request Update Request body

application/json, text/json 
 {
    "WorkflowRequestType":21,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "RequestExtension":
    {
        "WorkflowRequestExtensionType":17,
        "Data":
        {
            "SysHoldRequestID":820510,
            "PickupBranchID":3,
            "ActivationDate":"4/04/2018",
            "ExpirationDate":"2018-10-01T23:59:59-04:00",
            "HoldTillDate":"2018-03-28T23:59:59-04:00",
            "BibliographicRecordID":343351,
            "ItemRecordID":1327808,
            "ItemLevelHold":false,
            "PACDisplayNotes":"Pac Display notes",
            "StaffDisplayNotes":"Staff display notes",
            "NonPublicNotes":"Non public notes",
            "BorrowByMail":false
        }
    },
    "WorkflowReplies":null
 }

Response Information

Example - Patron code excluded to mail to patron
application/json, text/json 
{
    "WorkflowRequestGuid":"7580cb3f-7895-4f54-bf0a-72fe409eb228",
    "WorkflowRequestType":21,
    "WorkflowStatus":-3,
    "Prompt":
    {  "WorkflowPromptID": 21,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 6,
        "DefaultPromptOption": 5,
        "Title": "Patron code excluded",
        "Message": "Patron code has been excluded from borrow by mail.

Patron:  Mary test ramaraos
Title: MURDER AT MAGPIE FLATS

Do you want to place this request?",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Material excluded to mail to patron
application/json, text/json 
{
    "WorkflowRequestGuid":"7580cb3f-7895-4f54-bf0a-72fe409eb228",
    "WorkflowRequestType":21,
    "WorkflowStatus":-3,
    "Prompt":
    {   "WorkflowPromptID": 21,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 6,
        "DefaultPromptOption": 5,
        "Title": "Material is excluded",
        "Message": "This item material type is restricted from filling a borrow by mail request.

Title: LIE DETECTORS THEIR HISTORY AND USE

Do you want to place this request?",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Items are not available to mail to patron
application/json, text/json 
{
    "WorkflowRequestGuid":"7580cb3f-7895-4f54-bf0a-72fe409eb228",
    "WorkflowRequestType":21,
    "WorkflowStatus":-3,
    "Prompt":
    { 
        "WorkflowPromptID": 48,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 8,
        "DefaultPromptOption": 1,
        "Title": "Do not mail to patron",
        "Message": "This item is marked 'Do not mail to patron'. To fill this request, uncheck this option on one or more items or uncheck the Borrow by mail option for this request. 

Title: Murder at Magpie Flats",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": null

    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Change pick up branch response
application/json, text/json 
{
    "WorkflowRequestGuid":"7580cb3f-7895-4f54-bf0a-72fe409eb228",
    "WorkflowRequestType":21,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":48,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":0,
        "Title":"Change Pickup Branch",
        "Message":"Do you want to continue with this operation? 
            You are changing this item's pickup branch to: Argyle Free Library (ARG)
            The item will remain held until it is rerouted to the new location.
            Title:  Chili dawgs always bark at night",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Move unclaim date
application/json, text/json 
{
    "WorkflowRequestGuid":"8ddc305f-cd61-4f38-9920-8192aec2bb9c",
    "WorkflowRequestType":21,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":48,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":0,
        "Title":"Closed day",
        "Message":"Unclaimed date is a closed date. It will be moved to next open date.",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}

Hold request Update Response Information

Example: DtoWorkflowAnswer - Update hold request successful
application/json, text/json 
{
    "WorkflowRequestGuid":"811a22e5-9eb1-4239-bb96-58e6ff12a32f",
    "WorkflowRequestType":21,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
    [
        {
            "Type":1,
            "Title":"",
            "Message":"The hold request has been updated."
        }
    ],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_HoldRequests_Modify