Delete Item Record

Start Delete Item Record Process

POST /api/.../workflow

This method allows the caller to delete list of item 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 item record request, this must be set to 10 (DeleteItemRecord).
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 item record request requires a DtoDeleteItemRecordExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
DtoWorkflowRequestExtension
Property Type Nullable Description
WorkflowRequestExtensionType Int No For a delete item record request, the extension type must be 8 (DeleteItemRecordData).
Data Object No This must be an extension data object of type DtoDeleteItemRecordExtensionData.
DtoDeleteItemRecordExtensionData
Property Type Nullable Required Description
IsAutoDelete Boolean No Yes Set to false. Reserved for future use with reserve item records.
ItemRecordIDs List of integer No Yes Required. List of Item record IDs. Unique identifier for each item to delete.
Request body
application/json, text/json 
{
    "WorkflowRequestType":10,
    "TxnBranchID":"3",
    "TxnUserID":"1012",
    "TxnWorkstationID":"1218",
    "WorkflowReplies":null,
    "RequestExtension":{
        "WorkflowRequestExtensionType":8,
        "Data":{
            "IsAutoDelete":false,   
            "ItemRecordIDs":[457573,1966208]
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Delete item record successful
application/json, text/json 
{
    "WorkflowRequestGuid":"c457e0b8-3d89-45dc-abcd-a389f0993203",
    "WorkflowRequestType":10,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 item record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"1 item record(s) were not deleted"
        }
    ],
    "AnswerExtension":{
        "WorkflowAnswerExtensionType":6,
        "Data":{
            "RecordSetID":0,
            "ReportTitle":null,
            "ReportURL":null,
            "DeletedRecordIDs":[457573],
            "BlockedRecordIDs":[1966208]
        }
    },
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete item record successful with Report URL
application/json, text/json 
{
    "WorkflowRequestGuid":"f447a4eb-c36a-4e80-90f5-e569fd28c80e",
    "WorkflowRequestType":10,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 item record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"1 item record(s) were not deleted"
        }
    ],
    "AnswerExtension":{
        "WorkflowAnswerExtensionType":6,
        "Data":{
             "RecordSetID":0,
            "ReportTitle":"Last Copy Or Record Report",
            "ReportURL":"reports/execution?reportName=Widow%20List%20Authority&reportPath=%2FSystem%2FInternal%2F&reportParameters=sTempTable%3D%23%231218_1012&reportFormat=PDF"
            "DeletedRecordIDs":[457573],
            "BlockedRecordIDs":[1966208]
        }
    },   
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete item record successful with Record Set ID
application/json, text/json 
{
    "WorkflowRequestGuid":"e04afea6-d58e-4af1-ab95-99a25e8ba496",
    "WorkflowRequestType":10,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 item record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"1 item record(s) were not deleted"
        }
    ],
    "AnswerExtension":{
        "WorkflowAnswerExtensionType":6,
        "Data":{
            "RecordSetID":1,
            "ReportTitle":null,
            "ReportURL":null,
            "DeletedRecordIDs":[457573],
            "BlockedRecordIDs":[1966208]
        }
    },
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete a single item record continue prompt
application/json, text/json 
{
    "WorkflowRequestGuid":"c457e0b8-3d89-45dc-abcd-a389f0993203",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":73,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":5,
        "Title":"Delete item record",
        "Message":"The item record will be marked for deletion.  Do you want to continue?",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete bulk records continue prompt
application/json, text/json 
{
    "WorkflowRequestGuid":"c457e0b8-3d89-45dc-abcd-a389f0993203",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":105,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":37,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":5,
        "Title":"Delete item records",
        "Message":"2 item records will be marked for deletion.  Do you want to continue?",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":{
            "WorkflowPromptExtensionType":35,
            "Data":{
                WarnBreakableLinks":1,
                "WarnUnBreakableLinks":1,
                "SuppressWarningBreakbleLinks":false,
                "SuppressWarningUnBreakbleLinks":false
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete item record breakable links prompt
application/json, text/json 
{
    "WorkflowRequestGuid":"2825c45f-752c-4ed1-91b9-75bf4a37585a",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":75,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":18,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":4,
        "Title":"Item Record Links (Breakable)",
        "Message":"The following links will be broken if you continue deleting item record [10715786]:",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":"Continue deleting",
        "PromptExtension":{
            "WorkflowPromptExtensionType":23,
            "Data":{
                "Messages":["This item record is linked to 1 other record set(s)."]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Last copy options
application/json, text/json 
{
    "WorkflowRequestGuid":"c457e0b8-3d89-45dc-abcd-a389f0993203",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":82,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":22,
        "WorkflowPromptOptions":10,
        "DefaultPromptOption":9,
        "Title":"Last copy options",
        "Message":"The following record options are available:",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":null,
        "PromptExtension":{
            "WorkflowPromptExtensionType":25,
            "Data":{
                "DeleteButtonEnabled":true,
                "SuppressButtonEnabled":true,
                "RetainButtonEnabled":true,
                "OpenButtonEnabled":false,
                "PrintButtonEnabled":false,
                "WidowedRecords":[
                    {
                    "ObjectTypeID":2,
                    "RecordID":1112880,
                    "Description":"Bibliographic Record 1112880 - Jeff's Test Title"
                    }
                ]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Last record options
application/json, text/json 
{
    "WorkflowRequestGuid":"c457e0b8-3d89-45dc-abcd-a389f0993203",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":82,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":22,
        "WorkflowPromptOptions":10,
        "DefaultPromptOption":9,
        "Title":"Last record options",
        "Message":"The following record options are available:",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":null,
        "PromptExtension":{
            "WorkflowPromptExtensionType":25,
            "Data":{
                "DeleteButtonEnabled":true,
                "SuppressButtonEnabled":false,
                "RetainButtonEnabled":true,
                "OpenButtonEnabled":false,
                "PrintButtonEnabled":false,
                "WidowedRecords":[
                    {
                        "ObjectTypeID":1,
                        "RecordID":890477,
                        "Description":"Authority Record 890477 - Young, Jeff D."
                    }
                ]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Widow processing error(s)
application/json, text/json 
{
    "WorkflowRequestGuid":"1541dd80-376c-476d-ad27-9a7cd7cf3277",
    "WorkflowRequestType":10,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":83,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":23,
        "WorkflowPromptOptions":8,
        "DefaultPromptOption":1,
        "Title":"Widow processing error(s)",
        "Message":"",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":null,
        "PromptExtension":{
            "WorkflowPromptExtensionType":26,
            "Data":{
                "Errors":[
                    "Authority record 890478 is locked by another user.","Authority record 890480 is locked by another user."
                ],
                "ReportTitle":null,
                "ReportURL":null
            }
        }
    },
    "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_ItemRecords_Delete
    CR_AutoDeleteReserveItemRecords_Allow