Delete Patron

Start Delete Patron Process

POST /api/.../workflow

This method allows the caller to delete list of patron records.

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 a delete patron request, this must be set to 7.
TxnBranchID Int No Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation.
RequestExtension DtoWorkflowRequestExtension No A delete patron request requires a DeletePatronRecordExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
DtoWorkflowRequestExtension
Property Type Nullable Description
DeletePatronRecordExtensionData Int No For a delete patron request, the extension type must be 21.
Data Object No This must be an extension data object of type DeletePatronRecordExtensionData.
DtoDeletePatronRecordExtensionData
Property Type Nullable Required Description
PatronRecordIDs List of integer No Yes Required. List of Patron record IDs. Unique identifier for each patron to delete.
Request body
application/json, text/json 
{
    "WorkflowRequestType":7,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "WorkflowReplies":null,
    "RequestExtension":
        {
        "WorkflowRequestExtensionType":21,
        "Data":{
            "PatronRecordIDs":[381701,381699,381696]
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Delete patron successful
application/json, text/json 
{
    "WorkflowRequestGuid":"3c958fe4-ec3e-40e0-b2c3-d29f92d9ba30",
    "WorkflowRequestType":7,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
        [
        {"Type":1,"Title":"","Message":"1 patron record(s) deleted successfully"},
        {"Type":4,"Title":"","Message":"2 patron record(s) were not deleted"}
        ],
    "AnswerExtension":
    {
        "WorkflowAnswerExtensionType":6,
        "Data":
        {
            "RecordSetID":0,
            "ReportTitle":null,
            "ReportURL":null,
            "DeletedRecordIDs":[381701],
            "BlockedRecordIDs":[381699,381696]}},
            "CircTranType":0,
            "ReceiptType":0,
            "ReceiptUrl":"",
            "FineEReceiptSent":false
        }
    }
}
Example: DtoWorkflowAnswer - Delete patron failed with prompts
application/json, text/json 
{
    "WorkflowRequestGuid": "fd15869b-0c9c-45ff-ae1c-c39c3384a3e7",
    "WorkflowRequestType":7,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 46,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 9,
        "DefaultPromptOption": 0,
        "Title": "Delete of patron is not possible",
        "Message": "Patron is locked by PolarisExec on JeffY Windows 8",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "Cancel Deletion",
        "AlternateContinueText": "",
        "PromptExtension": null
    },
    "InformationMessages": [
        {
            "Type": 3,
            "Message": "Patron Registration is locked by PolarisExec on JeffY Windows 8"
        }
    ],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent":false
}

{
    "WorkflowRequestGuid": "b8da789f-6a02-4b3c-a627-5a32ab078a9c",
    "WorkflowRequestType":7,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 40,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 11,
        "WorkflowPromptOptions": 9,
        "DefaultPromptOption": 0,
        "Title": "Patron Record Links",
        "Message": "Delete of patron is not possible",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "Cancel Deletion",
        "AlternateContinueText": "Continue Deletion",
        "PromptExtension": {
            "WorkflowPromptExtensionType": 20,
            "Data": {
                "PatronID": 381701,
                "PatronBarcode": "111000222",
                "PatronName": "Mr. Melony MelCat",
                "PatronLinks": [
                    "Patron record is set to do not delete. (unbreakable)",
                    "Patron has unresolved charge(s) for $24.20."
                ]
            }
        }
    },
    "InformationMessages": [ ],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent":false
}


{
    "WorkflowRequestGuid": "94b004f2-7265-4db5-981d-5ad930ec8bcc",
    "WorkflowRequestType": 7,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 40,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 11,
        "WorkflowPromptOptions": 6,
        "DefaultPromptOption": 0,
        "Title": "Patron Record Links",
        "Message": "Delete of patron is not possible",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "Cancel Deletion",
        "AlternateContinueText": "Continue Deletion",
        "PromptExtension": {
            "WorkflowPromptExtensionType": 20,
            "Data": {
                "PatronID": 381701,
                "PatronBarcode": "1000201416293",
                "PatronName": "Ms. Gail V Guevara",
                "PatronLinks": [
                    "Patron has 1 library assigned block(s).",
                    "Patron has 1 free text block(s)."
                ]
            }
        }
    },
    "InformationMessages": [ ],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent":false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_PatronRegistration_Delete