Delete Serial Holdings Record

Start Deleting Process

POST /api/.../workflow

This method allows the caller to delete a serial holdings record.

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 delete serial holdings record, this must be set to 31.
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 delete serial holdings record requires a DtoWorkflowRequestExtension that contains a DtoDeleteSHRExtensionData 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 To delete serial holdings record, the extension type must be a 28 (DeleteSHRExtensionData).
Data Object No This must be an extension data object of type DtoDeleteSHRExtensionData
DtoDeleteSHRExtensionData
Property Type Nullable Required Description
CopyID Int No Yes ID of serial holdings record to delete.
Request body
application/json, text/json 
    {    
        "WorkflowRequestType":31,
        "TxnBranchID":"3",
        "TxnUserID":"1",
        "TxnWorkstationID":"1237",
        "WorkflowReplies":null,
        "RequestExtension":
        {
            "WorkflowRequestExtensionType":28,
            "Data":{
                "CopyID":255
            }
        }
    }

Response Information

Example: DtoWorkflowAnswer - Delete serial holdings record successfully
application/json, text/json 
{
    "WorkflowRequestGuid":"9c1657fc-ddb5-4372-8fe4-d56576bde887",
    "WorkflowRequestType":31,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
        [
            {
                "Type":1,
                "Title":"",
                "Message":"The record was deleted successfully."
            }
        ],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Delete serial holdings record with linked issues/parts
application/json, text/json 
{
    "WorkflowRequestGuid":"9c1657fc-ddb5-4372-8fe4-d56576bde887",
    "WorkflowRequestType":31,
    "WorkflowStatus":-3,
    "Prompt":
        {
            "WorkflowPromptID":123,
            "Name":null,"Description":null,
            "WorkflowPromptType":1,
            "WorkflowPromptOptions":6,
            "DefaultPromptOption":4,
            "Title":"Linked Issues/Parts",
            "Message":"There are one or more issues/parts with a status of 'Never Published', 'Not Available'.
Do you still want to continue deleting this serial holdings record?",
            "AlternateMessage":"",
            "AlternateYesText":"",
            "AlternateNoText":"",
            "AlternateCancelText":"",
            "AlternateContinueText":"",
            "PromptExtension":null
        },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: Reply to the server to continue deleting record with linked issues/parts
PUT /api/.../workflow/9c1657fc-ddb5-4372-8fe4-d56576bde887 
{
    "WorkflowPromptID":123,
    "WorkflowPromptResult":5,
    "ReplyValue":null,
    "ReplyExtension":null
}
Example: DtoWorkflowAnswer - 'Received' linked issue/parts exist. Delete serial holding record failed
application/json, text/json 
{
    "WorkflowRequestGuid":"d172a5d0-ac5e-47bf-8714-74cfbc4acac4",
    "WorkflowRequestType":31,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":66,
        "Name":null,"Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":8,
        "DefaultPromptOption":1,
        "Title":"Linked Issues/Parts",
        "Message":"There are 'received' issue or part records linked to this serial holdings record. The delete operation failed.",
        "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
403 Not permitted.

Required Permissions

Permission IDs found here.

    CR_SerialCopyRecords_Delete (DestinationOrgID)