Pre-Check Add Local Hold Request

GET /api/.../patrons/{id}/holdsprecheck

Pre-Check if patron is blocked from placing new hold requests. Returns list of blocks associated with the patron and if the staff user is permitted to override CR_OverrideRequestBlocks_Allow permission. For complete process to place a hold see Holds Workflow

Permissions

This call requires the HoldRequests_Create (ID: 89) permission to create the request

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.

Response Information

Example
application/json, text/json
{
    "HeldItemBlock":true,
    "FirstLevelFineBlock":true,
    "UnreadMessageBlock":false,
    "SecondLevelFineBlock":true,
    "OverdueItemBlock":true,
    "ClaimLimitBlock":true,
    "BlockingNoteBlock":true,
    "CollectionAgencyBlock":true,
    "PatronSystemBlock":false,
    "LibraryAssignedBlock":true,
    "FreeTextBlock":true,
    "AssociatedPatronBlock":true,
    "OverrideRequestBlocksPermitted": true,
    "PatronBlocks":
    [
        {
            "PatronID":357374,
            "PatronFullName":"Ramaraos, వనజ 5.2",
            "BlockType":3,"
            "BlockID":104,
            "BlockDescription":"Patron owes money. Amount due: $548.41",
            "PatronBranchID":3,
            "CreationDate":null
        },
        {
            "PatronID":357374,
            "PatronFullName":"Ramaraos, వనజ 5.2",
            "BlockType":3,
            "BlockID":106,
            "BlockDescription":"Patron has 16 held items at registered branch of Amsterdam Free Library",
            "PatronBranchID":3,
            "CreationDate":null
        }
    ],
    "LinkedPatronBlocks":
    [
        {
        "PatronID":1044,
        "PatronFullName":"Smith, Mary A",
        "BlockType":100,
        "BlockID":10,
        "BlockDescription":"Library Assigned Block 1",
        "PatronBranchID":90,
        "CreationDate":"2018-04-19T10:16:54.02-04:00"
        }
    ]
}

HTTP Response Codes

Code Description
200 OK.
400

FAILURE due to invalid input or data validation.