Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
titleAlternate Response - Search
linenumberstrue
{
  "searchResultRows": [], // Response when no results are found.
  "totalPageCount": 0,
  "totalBibRecordsCount": "0",
  "totalItemRecordsCount": "0",
  "totalRecordsCount": "0",
  "showTotalCount": false,
  "errorMessage": null
}


To retrieve Dummy Records :

The dummy records will be returned only when Bib and Item has the same cataloging status.

Code Block
languagejs
titleSearch Dummy Records
{
  "deleted": false,
  "fieldValue": "",
  "fieldName": "",
  "owningInstitutions": [
    "" // Valid parameters are "PUL", "CUL" and "NYPL". Multiple values can be added separated with commas.
  ],
  "collectionGroupDesignations": [
    "NA" // Only NA is allowed.
  ], 
  "catalogingStatus": "Incomplete", // This cataloging status belongs to both bib and item. Only Incomplete must be here.
  "pageNumber": 0,
  "pageSize": 10
} 


To retrieve Items based on multiple item barcodes :

Code Block
languagejs
titleSearch Dummy Records
{
  "deleted": false, // Valid parameters are "true" and "false". It is a flag that is marked "true" when the item is deaccessioned.
  "fieldValue": "barcode1,barcode2,barcode3", // Multiple barcodes can be added separated with commas.
  "fieldName": "Barcode", // Valid parameters are "Barcode"
  "owningInstitutions": [
    "PUL","CUL" // Valid parameters are "PUL", "CUL" and "NYPL". Multiple values can be added separated with commas.
  ],
  "collectionGroupDesignations": [
    "Shared" // Valid parameters are "Shared", "Private" and "Open". Multiple values can be added separated with commas.
  ],
  "availability": [
    "Available" // Valid parameters are "Available" and "Not available". Multiple values can be added separated with commas.
  ],
  "materialTypes": [
    "Monograph" // Valid parameters are "Monograph", "Serial" and "Other". Multiple values can be added separated with commas.
  ],
  "useRestrictions": [
    "NoRestrictions" // Valid parameters are "NoRestrictions", "InLibraryUse" and "SupervisedUse". Multiple values can be added separated with commas.
  ],
  "catalogingStatus": "Complete", // Valid parameters are "Complete" and "Incomplete". Incomplete records are those missing critical information such as CGD, Use Restriction.
  "pageNumber": 0,
  "pageSize": 10
}