Reactivate a local Hold Request

Start Reactivate a local hold request Process

POST /api/.../workflow

This method allows to reactivate an existing local hold request.

Permissions

This call requires the HoldRequests_Modify (ID: 90) permission based on the pick up branch and the CR_HoldRequests_ReactivateRequest (ID: 482) permission toreactivate local request.

Workflow Steps

  • Patron is blocked (can be bypassed).
  • Maximum hold request limit has been reached (can be bypassed)
  • Material type limit has been reached for specific material (can be bypassed)
  • Title is blocked (can be bypassed)
  • Item is blocked (can be bypassed)

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. To reactivate a hold request, this must be set to 23.
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 reactivate a hold request requires a ReactivateRequestExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
ReactivateRequestExtensionData
Property Type Nullable Description
WorkflowRequestExtensionType Int No To fill hold request, the extension type must be a 19 (ReactivateHoldRequest).
Data Object No This must be an extension data object of type DtoReactivateRequestExtensionData
DtoReactivateRequestExtensionData
Property Type Nullable Description
SysHoldRequestID Integer No Primary key. Used to update hold request.
IgnorePatronBlocksPrompt Boolean Yes No

Reactivate hold Request body

application/json, text/json 
{
    "WorkflowRequestType":23,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "RequestExtension":
    {
        "WorkflowRequestExtensionType":19,
        "Data":{
            "SysHoldRequestID":820788,
            "IgnorePatronBlocksPrompt":false
        }
    },
    "WorkflowReplies":null
}

Response Information

Example - Patron blocks response
application/json, text/json 
{
    "WorkflowRequestGuid":"93718315-745e-4fe5-a701-87f17219c5b7",
    "WorkflowRequestType":5,
    "WorkflowStatus":-3,
    "Prompt":
    {
    "WorkflowPromptID":96,
    "Name":null,"Description":null,
    "WorkflowPromptType":3,
    "WorkflowPromptOptions":6,
    "DefaultPromptOption":0,
    "Title":"Patron is blocked",
    "Message":"Do you want to continue with this operation?",
    "AlternateYesText":"",
    "AlternateNoText":"",
    "AlternateCancelText":"",
    "AlternateContinueText":"",
    "PromptExtension":
    {
    "WorkflowPromptExtensionType":8,
        "Data":
        {
            "HeldItemBlock":true,
            "FirstLevelFineBlock":true,
            "UnreadMessageBlock":false,
            "SecondLevelFineBlock":true,
            "OverdueItemBlock":true,
            "ClaimLimitBlock":true,
            "BlockingNoteBlock":true,
            "CollectionAgencyBlock":true,
            "PatronSystemBlock":false,
            "LibraryAssignedBlock":true,
            "FreeTextBlock":true,
            "AssociatedPatronBlock":true,
            "PatronBlocks":[
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":3,"BlockID":103,"BlockDescription":"Total overdue items: 6","PatronBranchID":3,"CreationDate":null},
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":101,"BlockID":45854,"BlockDescription":"Free Text block","PatronBranchID":3,"CreationDate":"2015-12-10T16:50:31.567-05:00"}
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":101,"BlockID":45885,"BlockDescription":"Patron Registration Fee","PatronBranchID":3,"CreationDate":"2017-09-29T15:11:46.683-04:00"},
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":100,"BlockID":4,"BlockDescription":"Paid user fee at MEC","PatronBranchID":3,"CreationDate":"2016-04-11T14:33:54.847-04:00"},
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":100,"BlockID":6,"BlockDescription":"Verify Address","PatronBranchID":3,"CreationDate":"2015-12-10T16:51:36.943-05:00"},
                {"PatronID":357374,"PatronFullName":"Ramaraos, వనజ 5.2","BlockType":3,"BlockID":1024,"BlockDescription":"Patron account has been submitted to collection agency: Amsterdam","PatronBranchID":3,"CreationDate":null}
                ],
            "LinkedPatronBlocks":[{"PatronID":1044,"PatronFullName":"Smith, Mary A","BlockType":100,"BlockID":10,"BlockDescription":"Library Assigned Block 1","PatronBranchID":90,"CreationDate":"2018-04-19T10:16:54.02-04:00"}]
        }
    }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Exceeded total request limit
application/json, text/json 
{
    "WorkflowRequestGuid":"cdb2461d-d9d9-43f3-bada-36fa1c269f23",
    "WorkflowRequestType":5,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":68,"Name":null,
        "Description":null,"WorkflowPromptType":1,"WorkflowPromptOptions":6,
        "DefaultPromptOption":4,
        "Title":"Exceeded total request limit",
        "Message":"Patron (వనజ Ramaraos) has exceeded the maximum number of requests permitted.

Title:  Eileen [electronic resource] : A Novel

Do you want to place this request?",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Title is blocked
application/json, text/json 
{
"WorkflowRequestGuid":"cdb2461d-d9d9-43f3-bada-36fa1c269f23",
"WorkflowRequestType":5,
"WorkflowStatus":-3,
"Prompt":
{
    "WorkflowPromptID":89,
    "Name":null,
    "Description":null,
    "WorkflowPromptType":1,
    "WorkflowPromptOptions":6,
    "DefaultPromptOption":5,
    "Title":"Title is blocked",
    "Message":"Title: Eileen [electronic resource] : A Novel

All items are restricted from filling this request.

Do you want to place this request?",
    "AlternateYesText":"",
    "AlternateNoText":"",
    "AlternateCancelText":"",
    "AlternateContinueText":"",
    "PromptExtension":null
},
"InformationMessages":[],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
Example - Item is blocked and not holdable
application/json, text/json 
{
    "WorkflowRequestGuid":"0f440a80-1df3-4d05-99fd-fc2f8e980924",
    "WorkflowRequestType":22,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":89,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":5,
        "Title":"Item is blocked",
        "Message":"Title: Second foundation.
This item is not holdable.
Do you want to fill the request with this item?",
        "AlternateYesText":"","AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}

Reactivate Hold request Response Information

Example: DtoWorkflowAnswer - Reactivate hold request successful
application/json, text/json 
{
    "WorkflowRequestGuid":"f6542778-578d-4f64-b1dc-3970b2539ac2",
    "WorkflowRequestType":23,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
    [
        {
        "Type":1,
        "Title":"",
        "Message":"Request successfully reactivated"}],
        "AnswerExtension":
        {
        "WorkflowAnswerExtensionType":9,
        "Data":
        {
            "HoldRequestInfo":
            {
            "SysHoldStatusID":7,
            "SysHoldStatus":"Not Supplied",
            "StatusTransitionDate":"2018-04-26T15:43:24.753-04:00",
            "CreationDate":"2018-04-26T15:43:24.753-04:00",
            "ActivationDate":"2018-04-26T00:00:00-04:00",
            "PickupBranchID":3,
            "ExpirationDate":"2018-05-06T23:59:59-04:00",
            "HoldTillDate":null,"Origin":"Library",
            "ItemLevelHold":true,"PatronID":357374,
            "PatronBarcode":"PACREG357374",
            "PatronName":"Mr. వనజ 5.2 Ramaraos",
            "PatronCodeID":1,
            "PatronBranchID":3,
            "PatronDeliveryOptionID":2,
            "Author":"SCHUMACH MURRAY 04(1913)99",
            "Title":"DIAMOND PEOPLE",
            "BrowseAuthor":"Schumach, Murray, 1913-",
            "BrowseTitle":"The diamond people.",
            "BrowseTitleNonFilingCount":0,
            "BibliographicRecordID":87289,
            "ItemBarcode":"0000500564471",
            "ItemRecordID":881625,
            "ItemStatusID":0,
            "MARCTOMID":1,
            "Publisher":"Norton,",
            "PublicationYear":1981,
            "Edition":null,
            "ISBNISSN":"0393014045",
            "ISBN":"0393014045",
            "ISSN":null,
            "LCCN":"80014947",
            "CallNumber":"338.2782 S",
            "Pages":null,
            "VolumeNumber":null,
            "StaffDisplayNotes":null,
            "NonPublicNotes":null,"PatronNotes":null,
            "PACDisplayNotes":null,
            "UnlockedRequest":false,
            "Designation":null,
            "CopyNo":0,
            "BorrowByMail":false,
            "TrackingNumber":null,
            "Series":null,
            "ConstituentBibRecordID":0,
            "ConstituentSortAuthor":null,
            "ConstituentSortTitle":null,
            "ConstituentBrowseAuthor":null,
            "ConstituentBrowseTitle":null,
            "NewPickupBranchID":0,
            "InnReachType":0,
            "MARCTOMIDDescription":"Book",
            "TrappingItemAssignedBranchID":0
            }
        }
    },
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
    }
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_HoldRequests_Modify (based on the pickup branch ID)
    CR_HoldRequests_ReactivateRequest (based on the pickup branch ID)