Delete Bibliographic Record

Start Delete Bibliographic Record Process

POST /api/.../workflow

This method allows the caller to delete list of bibliographic 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 bib record request, this must be set to 11 (DeleteBibRecord).
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 bib record request requires a DtoDeleteBibRecordExtensionData 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 bib record request, the extension type must be 10 (DeleteBibRecordData).
Data Object No This must be an extension data object of type DtoDeleteBibRecordExtensionData.
DtoDeleteBibRecordExtensionData
Property Type Nullable Required Description
BibRecordIDs List of integer No Yes Required. List of BibRecord IDs. Unique identifier for each Bibliographic record to delete.
Request body
application/json, text/json 
{
    "WorkflowRequestType":11,
    "TxnBranchID":"3",
    "TxnUserID":"1012",
    "TxnWorkstationID":"1218",
    "WorkflowReplies":null,
    "RequestExtension":{
        "WorkflowRequestExtensionType":10,
        "Data":{
            "BibRecordIDs":  [3, 0, 771420]
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Delete bib record successful
application/json, text/json 
{
    "WorkflowRequestGuid":"32b358c6-fa40-409b-b5d5-b1bd12df34be",
    "WorkflowRequestType":11,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 bibliographic record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"2 bibliographic record(s) were not deleted"
        }
    ],
    "AnswerExtension":{
        "WorkflowAnswerExtensionType":6,
        "Data":{
            "RecordSetID":0,
            "ReportTitle":null,
            "ReportURL":null,
            "DeletedRecordIDs":[771420],
            "BlockedRecordIDs":[0, 3]
        }
    },
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete bib record successful with Report
application/json, text/json 
{
    "WorkflowRequestGuid":"2a884f48-6cd8-49fb-b841-3ab2ca841d46",
    "WorkflowRequestType":11,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 bibliographic record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"2 bibliographic 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":[771420],
            "BlockedRecordIDs":[0, 3]
        }
    },   
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete bib record successful with Record Set ID
application/json, text/json 
{
    "WorkflowRequestGuid":"7c66d555-c796-4325-9acb-f8d75d9bc2d0",
    "WorkflowRequestType":11,
    "WorkflowStatus":1,
    "Prompt":null,
     "InformationMessages":[
        {
        "Type":1,
        "Title":"",
        "Message":"1 bibliographic record(s) deleted successfully"
        },
        {
        "Type":4,
        "Title":"",
        "Message":"2 bibliographic record(s) were not deleted"
        }
    ],
    "AnswerExtension":{
        "WorkflowAnswerExtensionType":6,
        "Data":{
            "RecordSetID":37656,
            "ReportTitle":null,
            "ReportURL":null
            "DeletedRecordIDs":[771420],
            "BlockedRecordIDs":[0, 3]
        }
    },  
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete a single bib record continue prompt
application/json, text/json 
{
    "WorkflowRequestGuid":"ba8ce734-7b49-48b2-bdc3-c42f56d60091",
    "WorkflowRequestType":11,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":79,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":5,
        "Title":"Delete bibliographic record",
        "Message":"The bibliographic 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 bibliographic 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 - Bibliographic Record Links (Unbreakable)
application/json, text/json 
{
    "WorkflowRequestGuid":"ba8ce734-7b49-48b2-bdc3-c42f56d60091",
    "WorkflowRequestType":11,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":76,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":18,
        "WorkflowPromptOptions":9,
        "DefaultPromptOption":4,
        "Title":"Bibliographic Record Links (Unbreakable)",
        "Message":"Deletion of bibliographic record [1112880] is not possible due to the following unbreakable link(s):",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":null,
        "PromptExtension":{
            "WorkflowPromptExtensionType":23,
            "Data":{
                "Messages":[
                "This bibliographic record is linked to 1 item record."]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Last record options
application/json, text/json 
{
    "WorkflowRequestGuid":"0fa8aa40-19cc-4c67-b99b-e254611cad68",
    "WorkflowRequestType":11,
    "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":true,
                "WidowedRecords":[
                    {
                        "ObjectTypeID":1,
                        "RecordID":890481,
                        "Description":"Authority Record 890481 - Young, Jeff D."
                    }
                ]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Widow processing error(s)
application/json, text/json 
{
    "WorkflowRequestGuid":"311bd624-ed9d-413d-b3e6-ec786df49f1b",
    "WorkflowRequestType":11,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":83,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":23,
        "WorkflowPromptOptions":8,
        "DefaultPromptOption":1,
        "Title":"Widow processing error(s)",
        "Message":"Record Set weeded0045 (Amsterdam) has been created.",
        "AlternateYesText":null,
        "AlternateNoText":null,
        "AlternateCancelText":null,
        "AlternateContinueText":null,
        "PromptExtension":{
            "WorkflowPromptExtensionType":26,
            "Data":{
                "Errors":[
                    "Authority record 890482 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_BibliographicRecords_Delete