Update ILL Request

Start Update ILL Request Process

POST /api/.../workflow

This method allows the caller to update an existing ill request.

Partial ill request updates are allowed. For example, passing only the PickupBranchID in the DtoWorkflowRequestExtension JSON will only update that single field. The API will load the existing ill request and merge the fields passed in to the 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 update ill request, this must be set to 17.
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 An update ill request requires a ILLRequestExtensionData 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 an update ill request, the extension type must be a 13 (ILLRequestData).
Data Object No This must be an extension data object of type DtoILLRequestExtensionData
DtoILLRequestExtensionData
Property Type Nullable Description
ILLRequestID Integer No Primary key. Used to update an ill request.
PickupBranchID Int Yes
Author String Yes
Title String Yes
MARCTOMID Integer Yes
RequestTypeID Integer Yes
NeedByDate DateTime Yes
Publisher String Yes
PublicationYear Integer Yes
ISBN String Yes
ISSN String Yes
LCCN String Yes
Edition String Yes
Series String Yes
VolumeAndIssue String Yes
HoldTillDate DateTime Yes
ReturnUncirc Boolean Yes
StaffNotes1 String Yes
StaffNotes2 String Yes

ILL Request Update Request body

application/json, text/json 
 {
    "WorkflowRequestType": 17,
    "TxnBranchID": 3,
    "TxnUserID": 1,
    "TxnWorkstationID": 1205,
    "RequestExtension": {
        "WorkflowRequestExtensionType": 13,
        "Data": {
            "ILLRequestID": 3,
            "VolumeAndIssue": "Volume And Issue"          
        }
    },
    "WorkflowReplies": null
}

ILL request Update Response Information

Example: DtoWorkflowAnswer - Update Ill request successful
application/json, text/json 
{
    "WorkflowRequestGuid":"00000000-0000-0000-0000-000000000000",
    "WorkflowRequestType":17,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
    [
        {
            "Type":1,
            "Title":"",
            "Message":"The ILL request has been updated."
        }
    ],
    "AnswerExtension":
    {
        "WorkflowAnswerExtensionType":8,
         "Data":
          {
            "ILLRequestInfo":
            {
                "ILLRequestID":3,
                "PatronName":"Lorish, Siivi",
                "PatronBarcode":"ann",
                "PatronPhone":"315-634-1234",
                "PatronEmail":"ann.lorish@polarislibrary.com",
                "PatronID":222730,
                "PickupBranchID":5,
                "CreationDate":"2008-03-05T09:30:30.57-05:00",
                "NeedByDate":"2009-03-05T09:30:30.57-05:00",
                "ActivationDate":null,
                "Author":null,
                "Title":"UNLOCK ME",
                "BrowseAuthor":null,
                "BrowseTitle":"UNLOCK ME",
                "MARCTOMID":5,
                "MediumType":"Printed",
                "Publisher":null,
                "PublicationYear":1909,
                "LCCN":null,
                "ISBN":null,
                "ISSN":null,
                "VolumeAndIssue":"",
                "Series":null,
                "Edition":null,
                "RequestType":"Loan",
                "RequestTypeID":1,
                "ItemBarcode":null,
                "ILLStatusID":1,
                "CurrentStatus":"Inactive",
                "PreviousStatus":"Inactive",
                "StatusTransitionDate":"2008-03-05T09:30:30.57-05:00",
                "StaffNotes1":null,
                "StaffNotes2":null,
                "OPACNotes":null,
                "InnReachType":0,
                "MARCTOMDescription":"Sound Recording",
                "CentralItemType":0,
                "CentralCode":null,
                "ReturnUncirc":false,
                "InnReachBibCallNumber":null,
                "BibliographicRecordID":0,
                "HoldTillDate":null,
                "ItemStatusID":0,
                "ItemRecordID":0,
                "InnReachTrackingID":0,
                "AssignedBranchID":0,
                "ILLMessageDetailSentDate":null
            }
        }
    },
    "CircTranType":0,"ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_ILLRequests_Modify