Delete ILL request

Start Deleting Process

POST /api/.../workflow

This method allows the caller to delete an ill request.

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 ill request, this must be set to 19.
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 ill request requires a DtoWorkflowRequestExtension that contains a DtoDeleteILLRequestExtensionData 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 ill request, the extension type must be a 15 (DeleteILLRequestData).
Data Object No This must be an extension data object of type DtoDeleteILLRequestExtensionData
DtoDeleteILLRequestExtensionData
Property Type Nullable Required Description
ILLRequestID Int No Yes ILL request ID of request to delete.
Request body
application/json, text/json 
{
    "WorkflowRequestType":19,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1205",
    "WorkflowReplies":null,
    "RequestExtension":
    {
        "WorkflowRequestExtensionType":15,
        "Data":
        {
            "ILLRequestID":482
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Delete ILL request successfully
application/json, text/json 
 {
    "WorkflowRequestGuid":"00000000-0000-0000-0000-000000000000",
    "WorkflowRequestType":19,
    "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 ILL request with breakable item record links
application/json, text/json 
{
  "WorkflowRequestGuid": "87755d50-fe0d-44e8-aac5-00b37164ff9a",
  "WorkflowRequestType": 19,
  "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 [771254]:",
    "AlternateYesText": null,
    "AlternateNoText": null,
    "AlternateCancelText": null,
    "AlternateContinueText": "Continue deleting",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 23,
      "Data": {
        "Messages": [
          "This bibliographic record is linked to 1 other record set(s)."
        ]
      }
    }
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Delete ILL request failed
application/json, text/json 
{
  "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
  "WorkflowRequestType": 19,
  "WorkflowStatus": 2,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 2,
      "Title": "",
      "Message": "Unexpected item status '11'. ILL request update failed."
    },
    {
      "Type": 2,
      "Title": "",
      "Message": "Ill request update failed."
    }
  ],
  "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_ILLRequests_Delete