Make Claim

Start Make Claim Process

POST /api/.../workflow

This method allows the caller to claim an item.

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 claim, this must be set to 6
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 A make claim request requires a DtoWorkflowRequestExtension that contains a DtoMakeClaimData 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 make claim request, the extension type must be a 3 (MakeClaimData).
Data Object No This must be an extension data object of type DtoMakeClaimData
DtoMakeClaimData
Name Type Required Description
PatronID Integer Yes ID of patron
ItemClaimInfo DtoItemClaimInfo Yes Required. List of DtoItemClaimInfo objects and conversation PAPI properties. Unique identifier for each claim.
DtoItemClaimInfo
Property Type Nullable Description
ItemRecordID Int No ID of item record, primary key.
ClaimType Int No Status of the item. Choices are 8 ('Claim Returned') or 9 ('Claim Never Had')
AssignedBranchID Int Yes
AssociatedBibRecordID Int Yes
Request body
application/json, text/json 
{
    "WorkflowRequestType": 6,
    "TxnBranchID": 3,
    "TxnUserID": 1,
    "TxnWorkstationID": 923,
    "RequestExtension": {
        "WorkflowRequestExtensionType": 3,
        "Data": {
            "PatronID": 1,
            "ItemClaimInfo": [ {
                "ItemRecordID": 1319575,
                "AssignedBranchID": 7,
                "AssociatedBibRecordID": 210055,
                "ClaimType": 8
            } ]
        }
    },
    "WorkflowReplies": null
}

Response Information

Example: DtoWorkflowAnswer - Check in successful
application/json, text/json 
{
    "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
    "WorkflowRequestType":6,
    "WorkflowStatus": 1,
    "Prompt": null,
    "InformationMessages": [
        {
            "Type": 1,
            "Title": "",
            "Message": "Claim successful"
        }
    ],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent":false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    AccessCirculationControl_Allow
    OverrideClaimedItemLimits_Allow