Item Records

Get item record by Id

GET /api/.../itemrecords/{id}

Returns all the data related to item record eg.

  1. Item Record Detail
  2. Item Notification Data
  3. Item Acquisition Data
  4. Item Hold Request Links
  5. Item Reserve Data
  6. Item Course Reserve Links
  7. Item Bib Info
  8. Item Linked Serial Data

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the item record.
isBarcode Boolean No The specified id is a barcode.
patronID Integer View dependent The unique id assigned to a patron record. Used with view parameter. Required for:
  • circview
  • lostdisplayview
  • ors
view String No Values:

Response Information

Example
application/json, text/json
{
    "ItemRecordID":2251703,
    "OwningBranchID":90,
    "CreatorID":455,
    "ModifierID":895,
    "CreatorName":"PolarisExec",
    "ModifierName":"PolarisExec
    "CallNumberPrefix":"DVD",
    "ClassificationNumber":null,
    "CutterNumber":"UPST",
    "CallNumberSuffix":"4DSeason 5",
    "CopyNumber":null,
    "VolumeNumber":null,
    "TemporaryShelfLocation":null,
    "PublicNote":null,
    "NonPublicNote":null,
    "CreationDate":"2005-08-03T14:26:08.51-04:00",
    "ModificationDate":"2011-12-14T14:55:05.573-05:00",
    "ImportedDate":null,
    "LastInventoryDate":null,
    "Price":67.9900,
    "LoanableOutsideSystem":false,
    "HoldableByPickup":true,
    "HoldPickupBranchID":90,
    "HoldableByBranch":false,
    "HoldableByLibrary":false,
    "HoldableByPrimaryLender":false,
    "RenewalLimit":1,
    "Holdable":true,
    "ImportedBibControlNumber":null,
    "ImportedRecordSource":null,
    "PhysicalCondition":null,"NameOfPiece":null,"FundingSource":null,
    "AcquisitionDate":null,"ShelvingSchemeID":3,
    "CallNumber":"DVD UPST 4DSeason 5",
    "Barcode":"0000203660436",
    "ItemStatusID":5,
    "ItemStatusDescription":"Transferred",
    "LastCircTransactionDate":"2013-07-02T09:55:54.333-04:00",
    "AssociatedBibRecordID":825154,
    "ParentItemRecordID":0,
    "RecordStatusID":1,
    "RecordStatusDate":"2005-08-03T14:26:09-04:00",
    "AssignedBranchID":90,
    "AssignedCollectionID":135,
    "AssignedCollectionName":"Adult Video",
    "MaterialTypeID":3,
    "LastUsePatronID":68901,
    "LastUsePatronBarcode":"1000201440053",
    "LastUseBranchID":90,
    "YTDCircCount":0,
    "YTDPrevCircCount":0,
    "LifetimeCircCount":42,
    "YTDInHouseUseCount":0,
    "YTDPrevInHouseUseCount":0,
    "LifetimeInHouseUseCount":0,
    "FreeTextBlock":null,
    "ManualBlockID":0,
    "ManualBlockDescription":null,
    "FineCodeID":24,
    "FineCodeDescription":"Video",
    "LoanPeriodCodeID":10,
    "LoanPeriodCodeDescription":"Video",
    "StatisticalCodeID":1,
    "StatisticalCodeDescription":"Adult/YA Fiction",
    "ShelfLocationID":0,
    "ShelfLocationDescription":"None",
    "ILLFlag":false,
    "DisplayInPAC":true,
    "NonCirculating":false,
    "DonorID":0,
    "LastCircWorkstationID":15,
    "LastCircPolarisUserID":911,
    "LastCircWorkstationName":"Peng Zhang",
    "LastCircUserName":"Zhang",
    "ItemStatusDate":"2013-07-02T09:55:54.343-04:00",
    "CheckInBranchID":90,
    "CheckInWorkstationID":743,
    "LastCheckInWorkstationName":"SAR",
    "CheckInUserID":578,
    "LastCheckInUserName":"sarcirc",
    "CheckInDate":"2007-12-15T11:53:37-05:00",
    "InTransitSentBranchID":3,
    "InTransitSentDate":"2013-07-02T09:55:54.333-04:00",
    "InTransitRecvdBranchID":90,
    "InTransitRecvdDate":null,
    "LastCheckOutRenewDate":null,
    "ShelvingBit":false,
    "FirstAvailableDate":"2005-08-03T14:26:08.51-04:00",
    "LoaningOrgID":90,
    "HomeBranchID":90,
    "ItemDoesNotFloat":false,
    "DoNotMailToPatron":false,
    "ElectronicItem":false,
    "ResourceEntityID":0,
    "VendorAccountID":0,
    "VendorAccountName":"Baltimore County Public Library",
    "VendorID":0,
    "VendorName":"OverDrive, Inc. (integrated)",
    "ResourceGroupID":0,
    "ResourceGroupName":"OverDrive",
    "SystemBlockOTF":false,
    "SystemBlockILL":false,
    "SystemBlockID":null,
    "SystemBlockDescription":null,
    "SpecialItemCheckInNote":null,
    "SystemBlockMissPart":false,
    "SystemBlockDamaged":false,
    "DelayedHoldsFlag":false,
    "DelayedNumberOfDays":null,
    "LanguageID":null,
    "LanguageDescription":null,
    "NotificationData":
     {
        "ItemRecordID":2251703,
        "OVDNoticeDate1":null,
        "OVDNoticeDate2":null,
        "OVDNoticeDate3":null,
        "BillingDate":null,
        "HoldNotificationDate":null,
        "ReminderDate":null
    },
    "AcquisitionData":
        {
        "ItemRecordID":2251703,
        "PONumberSuffix":null,
        "InvNumberSuffix":null,
        "DonorReadOnly":false,
        "DonorFirstName":null,
        "DonorMiddleName":null,
        "DonorLastName":null,
        "DonorCorporateName":null
    },
    "HoldRequestLinks":
        {
        "ItemRecordID":2251703,
        "HeldShippedPatronID":357295,
        "HeldShippedPatronBarcode":"zhangexpresstest",
        "HeldShippedPickupBranchID":90,
        "HeldShippedPickupBranchName":"Saratoga Springs Public Library (SAR)",
        "PendingPatronID":null,
        "PendingPatronBarcode":null,
        "PendingPickupBranchID":null,
        "PendingPickupBranchName":null,
        "PulledPatronID":null,
        "PulledPatronBarcode":null,
        "PulledPickupBranchID":null,
        "PulledPickupBranchName":null
    },
    "ReserveData":
        {
        "ReserveAssignedBranchID":0,
        "ReserveAssignedCollectionID":null,
        "ReserveShelfLocationID":null,
        "ReserveLoanPeriodCodeID":null,
        "ReserveFineCodeID":null,
        "ReserveRenewalLimit":0,
        "ReserveHoldable":0,
        "CopyRightFeeRequired":false,
        "CopyrightCompliance":null,
        "CopyrightFee":null,
        "CopyrightFeePaid":null,
        "LimitedToLibUse":null,
        "RequiresFullCataloging":null,
        "LibraryCopy":false,
        "DeleteWhenDone":false,
        "ActionWhenDone":0,
        "Purchase":false,
        "YTDCircCount":0,
        "Note":null
    },
    "CourseReserveLinks":
    {
        "CourseReserveID":0,"CourseName":null,
        "AlternateName":null,
        "CourseNumber":null,
        "SectionNumber":null,
        "ReserveStatus":0,
        "StartDate":null,"EndDate":null,
        "Note":null,
        "YTDCircCount":null
    },
    "BibInfo":
    {
        "ItemRecordID":2251703,
        "Barcode":"0000203660436",
        "BrowseTitle":"Upstairs, downstairs. The complete series [DVD]",
        "BrowseAuthor":"",
        "DueDate":null,
        "CallNumber":"DVD UPST 4DSeason 5",
        "MaterialType":"Video",
        "RenewalsLeft":"0 of 1",
        "AssignedBranch":"Saratoga Springs Public Library",
        "AssignedBranchID":90,
        "FormatID":33,
        "Renewals":0,
        "RenewalLimit":1,
        "BillingNoticeSent":false,
        "ReplCostTxnID":0,
        "ProcChargeTxnID":0,
        "OVDChargeTxnID":0,
        "BibliographicRecordID":825154,
        "DisplayInPAC":true,
        "CanItemBeRenewed":false,
        "IsChargeForCheckout":false,
        "ItemRenewalErrorCode":0,
        "LoanUnits":0,
        "ElectronicItem":false,
        "VendorAccountID":0,
        "VendorObjectIdentifier":"",
        "VendorID":0,
        "ISBN":"9780767049764",
        "ISSN":"",
        "OCLCNumber":"",
        "UPCNumber":"733961706079",
        "IsConstituent":"0",
        "HasConstituents":"0"
    },
    "LinkedSerialData":
    {
        "IssueID":0,
        "Designation":null,
        "LinkedToSOPart":false,
        "LinkedToSerialIssue":false
    },
    "CirculationData":
    {
        "ItemRecordID":2251703,
        "OriginalCheckoutDate":null,
        "OriginalDueDate":null,
        "RenewalDate":null,
        "DueDate":null,
        "CurrentBorrowerID":null,
        "PatronBarcode":null,
        "LoaningBranch":null,
        "LoaningBranchID":null,
        "RenewalCount":null
    }
}
Example 'circview'
application/json, text/json
{
  "ItemRecordID": 2254290,
  "Barcode": "123",
  "BrowseTitle": "My girl 2 [videorecording]",
  "BrowseAuthor": "",
  "DueDate": null,
  "CallNumber": "VC Fict My",
  "MaterialType": "Audiobook",
  "RenewalsLeft": "0 of 0",
  "AssignedBranch": "Amsterdam Free Library",
  "AssignedBranchID": 3,
  "FormatID": 34,
  "Renewals": 0,
  "RenewalLimit": 0,
  "BillingNoticeSent": false,
  "ReplCostTxnID": 0,
  "ProcChargeTxnID": 0,
  "OVDChargeTxnID": 0,
  "BibliographicRecordID": 373330,
  "DisplayInPAC": true,
  "CanItemBeRenewed": false,
  "IsChargeForCheckout": false,
  "ItemRenewalErrorCode": 0,
  "LoanUnits": 0,
  "ElectronicItem": false,
  "VendorAccountID": 0,
  "VendorObjectIdentifier": "",
  "VendorID": 0,
  "ISBN": "9780800188887",
  "ISSN": "",
  "OCLCNumber": "",
  "UPCNumber": "",
  "IsConstituent":"0",
  "HasConstituents":""
}
Example 'lostdisplayview'
application/json, text/json
{
  "PatronID": 358255,
  "ItemRecordID": 2254290,
  "ItemBarcode": "123",
  "AssignedBranchID": 3,
  "AssociatedBibRecordID": null,
  "ReplacementAmount": 25,
  "ReplacementOutstanding": 25,
  "ReplacementPaid": 0,
  "ReplacementWaived": 0,
  "ProcessingAmount": 0,
  "ProcessingOutstanding": 0,
  "ProcessingPaid": 0,
  "ProcessingWaived": 0,
  "OverdueAmount": 0,
  "OverdueOutstanding": 0,
  "OverduePaid": 0,
  "OverdueWaived": 0,
  "TotalFine": 25,
  "ReplacementActions": [
    2,
    6,
    1
  ],
  "ProcessingActions": [
    -2
  ],
  "OverdueActions": [
    -2
  ],
  "ModifyAmountPermitted": true,
  "ItemTitle": "",
  "PatronBarcode": null,
  "PatronName": "",
  "Billed": false,
  "LostOrDueDate": null,
  "BilledDate": null,
  "Caption": "",
  "LostItem": false,
  "OutItem": false,
  "DeclareLost": true,
  "CircResolveBilledItem": false,
  "CircResolveLostItem": false,
  "ModifyOverdueNotAllowed": true,
  "ModifyProcessingNotAllowed": true,
  "ModifyReplacementNotAllowed": false,
  "CheckoutBriefInfo": {
    "ItemRecordID": 0,
    "CreatorID": 0,
    "LoanUnits": 0,
    "LoanUnitsDescription": null,
    "LoaningBranchID": 0,
    "LoaningBranch": null,
    "Renewals": 0,
    "PatronID": 0,
    "PatronBarcode": null,
    "PatronBranchID": 0,
    "PatronCodeID": 0,
    "CheckOutDate": "0001-01-01T00:00:00-05:00",
    "DueDate": "0001-01-01T00:00:00-05:00",
    "OriginalCheckOutDate": null,
    "OriginalDueDate": null,
    "BillingNoticeSent": false,
    "BilledDate": null,
    "ReplCostTxnID": null,
    "ProcChargeTxnID": null,
    "OVDChargeTxnID": null,
    "CourseReserveID": null
  }
}
Example 'history'
application/json, text/json
[
  {
    "TransactionDate": "2016-10-10T10:59:58.677-04:00",
    "AssignedBranchID": 3,
    "AssignedBranch": "Amsterdam Free Library",
    "OldItemStatusID": 2,
    "OldItemStatus": "Out",
    "NewItemStatusID": 1,
    "NewItemStatus": "In",
    "ActionTakenID": 11,
    "ActionTaken": "Checked in",
    "OrganizationID": 3,
    "TransactingBranch": "Amsterdam Free Library",
    "PolarisUserID": 1,
    "PolarisUserName": "PolarisExec",
    "WorkstationID": 1218,
    "ComputerName": "YOUNG-W10",
    "PatronID": 358255,
    "PatronBarcode": "21756003332060",
    "PatronFullName": "Jetson, Astro \"ruh roh\"",
    "InTransitRecvdBranchID": 0,
    "InTransitBranch": null
  },
  {
    "TransactionDate": "2016-09-21T11:44:59.927-04:00",
    "AssignedBranchID": 3,
    "AssignedBranch": "Amsterdam Free Library",
    "OldItemStatusID": 1,
    "OldItemStatus": "In",
    "NewItemStatusID": 2,
    "NewItemStatus": "Out",
    "ActionTakenID": 75,
    "ActionTaken": "Checked out - Self Check",
    "OrganizationID": 3,
    "TransactingBranch": "Amsterdam Free Library",
    "PolarisUserID": 1,
    "PolarisUserName": "PolarisExec",
    "WorkstationID": 1218,
    "ComputerName": "YOUNG-W10",
    "PatronID": 358255,
    "PatronBarcode": "21756003332060",
    "PatronFullName": "Jetson, Astro \"ruh roh\"",
    "InTransitRecvdBranchID": 0,
    "InTransitBranch": null
  }
]
Example 'itemview'
application/json, text/json
{
  "ItemRecordID": 2254290,
  "AssignedCollectionID": 4,
  "AssignedCollectionName": "Adult Nonfiction",
  "ShelfLocationID": 0,
  "ShelfLocationDescription": "None",
  "MaterialTypeID": 5,
  "MaterialTypeDescription": "Audiobook",
  "AssignedBlockID": 2,
  "AssignedBlockDescription": "Check Contents",
  "FreeTextBlock": null,
  "PublicNote": null,
  "NonPublicNote": "testing"
}
Example 'ors'
application/json, text/json
{
    "ItemRecordID": 10001,
    "Barcode": "0000100563634",
    "BrowseAuthor": "Rodowsky, Colby F.",
    "BrowseTitle": "H, my name is Henley",
    "CallNumber": "J Fict",
    "ItemStatusID": 11,
    "RecordStatusID": 1,
    "AssignedBranchID": 101,
    "AssignedCollectionID": 25,
    "MaterialTypeID": 1,
    "AssociatedBibRecordID": 20431,
    "ShelfLocationID": null,
    "PatronID": null,
    "ShelfLocation": null,
    "SysHoldRequestID": 0,
    "HoldingPatronBarcode": null,
    "HoldingPatronPickupBranchID": 0,
    "BrowseTitleNonFilingCount": 0,
    "IsElectronicItem":false,
    "ORSPatronID": null,
    "HoldingPatronID": 0
}
Example 'recordset'
application/json, text/json
{
    "RecordID": 94184,
    "Title": "Frog goes to dinner",
    "AssignedBranch": "Saratoga Springs Public Library",
    "Collection": "Children's Picture Books (JP)",
    "MaterialType": "Book",
    "ShelfLocation": null,
    "CallNumber": "JP Fict May",
    "Volume": null,
    "Status": "In",
    "Barcode": "0000201275351",
    "LastActivityDate": "2000-11-29T00:00:00-05:00",
    "RecordStatus": "Final",
    "NonFilingTuple":null
}

HTTP Response Codes

Code Description
200 OK. Success