Delete Serial Issue or Part

Start Delete Serial Issue or Part Process

POST /api/.../workflow

This method allows the caller to delete a serial issue or part.

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 serial issue/part request, this must be set to 27 (DeleteSerialIssuePart).
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 serial issue/part request requires a DtoDeleteSerialIssuePartExtensionData 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 serial issue/part request, the extension type must be 24 (DeleteSerialIssuePartExtensionData).
Data Object No This must be an extension data object of type DtoDeleteSerialIssuePartExtensionData.
DtoDeleteSerialIssuePartExtensionData
Property Type Nullable Required Description
IssueOrPartID Integer No Yes Required. Issue/part record ID to be deleted.
Request body
application/json, text/json 
{
    "WorkflowRequestType":27,
    "TxnBranchID":"3",
    "TxnUserID":"1012",
    "TxnWorkstationID":"1218",
    "WorkflowReplies":null,
    "RequestExtension":{
        "WorkflowRequestExtensionType":24,
        "Data":{
            "IssueOrPartID":1966208
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Delete serial issue/part record successful
application/json, text/json 
{
    "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
    "WorkflowRequestType": 27,
    "WorkflowStatus": 1,
    "Prompt": null,
    "InformationMessages": [
    {
        "Type": 1,
        "Title": "",
        "Message": "The issue/part was deleted successfully."
    }
    ],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Delete serial issue/part record 'linked route lists' prompt
application/json, text/json 
{
    "WorkflowRequestGuid": "087e61af-f21d-4771-a42d-f188ac3ddd44",
    "WorkflowRequestType": 27,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 118,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 1,
        "DefaultPromptOption": 2,
        "Title": "Linked Records",
        "Message": "There are 1 records linked to this issue record. Do you want to continue?",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": null
    },
    "InformationMessages": [],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Delete serial issue/part record 'retained' prompt
application/json, text/json 
{
    "WorkflowRequestGuid": "2e519804-b1e6-4ef6-8e49-0ad2eb092bf8",
    "WorkflowRequestType": 27,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 116,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 1,
        "DefaultPromptOption": 2,
        "Title": "Issue/Part is Retained",
        "Message": "Retention settings in the linked Serial Holdings Record indicate the following is retained:

Testing Time magazine Test 2.
Stillwater Public Library
Vol. 168 No. 4  (July 24 2006)

Do you still want to delete this issue/part?",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": null
    },
    "InformationMessages": [],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Delete serial issue/part record 'display in PAC' prompt
application/json, text/json 
{
    "WorkflowRequestGuid": "9da4df18-d482-4d25-ad85-0bed2b57ede5",
    "WorkflowRequestType": 27,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 117,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 1,
        "DefaultPromptOption": 2,
        "Title": "Display in PAC",
        "Message": "Testing Time magazine Test 2.
Stillwater Public Library
Vol. 168 No. 1  (July 3 2006)

No other records are linked to its linked bibliographic record.
Do you still want to display this bibliographic record in the PAC?",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "",
        "PromptExtension": 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_SerialIssuesStandingOrderParts_Delete
    CR_CreateAndDeleteItemRecordFromAcquisitionsAndSerials_Allow