Patch Item Record Info with optional fields

Patch Item Record Info with optional fields

PATCH /api/.../itemrecords/optionalfields/{itemId}

Patch Item Record with ability to optionally patch the included fields. Provide those values that need to be updated. Collection ID, Library Assigned Block ID, and Shelf Location ID will be validated for the item's assigned branch ID. Permission checks will be performed.

Permissions

    CR_AccessCatalogingSubsystem_Allow
    CR_ManageItemDialogs_ModifyCirculationStatusWithdrawn
    CR_ManageItemDialogs_ModifyShelfLocation
    CR_ManageItemDialogs_ModifyAssignedCollection
    CR_ManageItemDialogs_ModifyMaterialType
    CR_ManageItemDialogs_ModifyNotes
    CR_ManageItemDialogs_ModifyBlocks (for FreeTextBlock or LibraryAssignedBlockID being set)

Request Information

Parameters
Name Type Required Description
itemId int Yes
object object Yes DtoUpdateItemRecord defines this object parameter in the request body.
DtoUpdateItemRecord
Property Type Nullable Description
Brn Integer No Bibliographic Record Identifier
VolumeNumber String Yes Volume identifier
BranchID Integer No Branch ID
ClassificationNumber String Yes Classification Number
MaterialTypeID Integer No Material Type ID
AssignedCollectionID Integer Yes Assigned Collection ID
LanguageID Integer Yes Language ID
CallNumberSuffix String Yes Call Number Suffix
Donor String Yes Donor
Price Decimal Yes Price
DisplayInPAC Boolean No Display In PAC
NonPublicNote String Yes Notes for staff view
PublicNote String Yes Notes for public view
NonCirculatingFlag Boolean No For reference item
ItemStatusID Integer No Item status
ShelvingSchemeID Integer No Shelving Scheme Id
ShelfLocationId Integer Yes Shelf Location Id
Holdable Boolean No Holdable flag
FineCodeID Integer Yes Fine Code ID
LibraryAssignedBlockID Integer yes Library Assigned Block ID
FreeTextBlock String Yes Free Text Block text
Example
application/json, text/json
   {
     "Brn": 5000,
     "VolumeName": "TV",
     "BranchID": 3,
     "ClassificationNumber": "SER",
     "MaterialTypeID": 1,
     "AssignedCollectionID": 1,
     "LanguageID": 1,
     "CallNumberSuffix": "suffix",
     "Donor": "newDonorName132",
     "Price": 50,
     "DisplayInPAC": true,
     "NonPublicNote": "nonBlockingNote",
     "PublicNote": "PublicNote",
     "NonCirculatingFlag": true,
     "ItemStatusID": 1,
     "ShelvingSchemeID": 1,
     "ShelfLocationID": null,
     "Holdable": false,
     "FineCodeId": 2,
     "LibraryAssignedBlockID": null,
     "FreeTextBlock": "free text block string"
    }

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
404 FAILURE.
  • Not Found