Undelete Item Record

Start Undelete Item Record Process

POST /api/.../workflow

This method allows the caller to undelete an item record that has a 'deleted' record status.

A successful undelete call will return the updated record status, modification date and display in PAC bit.

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 an undelete item record request, this must be set to 16 (UndeleteItemRecord).
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 An undelete item record request requires a DtoWorkflowRequestExtension that contains an item record ID.
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 an undelete item record, the extension type must be 5 (RecordIdData).
Data Object No This must be an extension data object of type RecordID.
Request body
application/json, text/json 
{
    "WorkflowRequestType":16,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"15",
    "RequestExtension":{
        "WorkflowRequestExtensionType":5,
        "Data":{
            "RecordID":447295
        }
    },
    "WorkflowReplies":null
}

Response Information

Example: DtoWorkflowAnswer - Undelete item record successful
application/json, text/json 
{
  "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
  "WorkflowRequestType": 16,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 3,
      "Title": "Re-establish links",
      "Message": "The record status has been changed to Final. Make sure to re-establish any necessary links."
    },
    {
      "Type": 1,
      "Title": "",
      "Message": "The record was undeleted successfully."
    }
  ],
  "AnswerExtension": {
    "WorkflowAnswerExtensionType": 7,
    "Data": {
      "RecordID": 10731281,
      "RecordStatusID": 1,
      "ModifierID": 1,
      "ModifierName": "PolarisExec",
      "ModificationDate": "2017-03-03T13:59:23.347-05:00",
      "DisplayInPAC": true
    }
  },
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Linked bib record not final
application/json, text/json 
{
  "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
  "WorkflowRequestType": 16,
  "WorkflowStatus": 2,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 3,
      "Title": "Record undelete failed",
      "Message": "Linked bibliographic record 1113017 does not have a status of final."
    },
    {
      "Type": 2,
      "Title": "",
      "Message": "Item record 10731281 was not undeleted."
    }
  ],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - Duplicate records found
application/json, text/json 
{
  "WorkflowRequestGuid": "17fd2bc0-13c3-41dd-840c-f60211cb5798",
  "WorkflowRequestType": 16,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 72,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 17,
    "WorkflowPromptOptions": 9,
    "DefaultPromptOption": 4,
    "Title": "Duplicate barcode detected",
    "Message": "This record appears to be a duplicate of existing records:",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 22,
      "Data": {
        "DuplicateRecords": [
          {
            "ObjectTypeID": 3,
            "ControlNumber": 10731281,
            "OwnerID": 2,
            "OwnerName": "Amsterdam ",
            "Reason": "Duplicate barcode"
          }
        ]
      }
    }
  },
  "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_AccessCatalogingSubsystem_Allow
    CR_ItemRecords_Delete