Patron Blocks Extension

List Patron Blocks with Extension

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

Return summary of blocks for patron with extensive 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: false,
    OverdueItemBlock: true,
    ClaimLimitBlock: false,
    BlockingNoteBlock: false,
    CollectionAgencyBlock: false,
    PatronSystemBlock: true,
    LibraryAssignedBlock: false,
    FreeTextBlock: false,
    AssociatedPatronBlock: true,
    PatronBlocks: 
    [
        {
            PatronID: 357295
            PatronFullName: "Zhang, TestCopy"
            BlockType: 3
            BlockID: 103
            BlockDescription: "Long overdue: 1 of 1"
        },
        {
            PatronID: 357295
            PatronFullName: "Zhang, TestCopy"
            BlockType: 3
            BlockID: 104
            BlockDescription: "Patron owes money. Amount due: $94.05"
        },
        {
            PatronID: 357295
            PatronFullName: "Zhang, TestCopy"
            BlockType: 3
            BlockID: 106
            BlockDescription: "Patron has 1 held items at registered branch of Saratoga Springs Public Library"
        },
        {
            PatronID: 357295
            PatronFullName: "Zhang, TestCopy"
            BlockType: 3
            BlockID: 4096
            BlockDescription: "Patron registration fee"
        }
    ],
    LinkedPatronBlocks: 
    [ 
      {
        "PatronID": 1,
        "PatronFullName": "sample string 2",
        "BlockType": 3,
        "BlockID": 4,
        "BlockDescription": "sample string 5"
      },
      {
        "PatronID": 1,
        "PatronFullName": "sample string 2",
        "BlockType": 3,
        "BlockID": 4,
        "BlockDescription": "sample string 5"
      },
      {
        "PatronID": 1,
        "PatronFullName": "sample string 2",
        "BlockType": 3,
        "BlockID": 4,
        "BlockDescription": "sample string 5"
      }
    ]
]
Example when PatronStatus_DisplayPatronBlocks (ID: 71) permission isn't permitted
application/json, text/json
[
    {
        HeldItemBlock: true
        FirstLevelFineBlock: true
        UnreadMessageBlock: false
        SecondLevelFineBlock: true
        OverdueItemBlock: false
        ClaimLimitBlock: false
        BlockingNoteBlock: false
        CollectionAgencyBlock: false
        PatronSystemBlock: true
        LibraryAssignedBlock: false
        FreeTextBlock: false
        PatronBlocks: 
        [
            {
                PatronID: 0
                PatronFullName: null
                BlockType: 0
                BlockID: 0
                BlockDescription: "< Insufficient privilege to view patron blocks >"
            }
        ]
        LinkedPatronBlocks: 
        [ 
        ]
    }
]

HTTP Response Codes

Code Description
200 OK. Success
404 FAILURE. Invalid Patron ID.