Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

The Search API is used to search through the collections available in SCSB.

Request - Search
{
  "deleted": false,
  "fieldValue": "",
  "fieldName": "",
  "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"
  "pageNumber": 0,
  "pageSize": 10
}
Response - Search
{
  "searchResultRows": [
    {
      "bibId": 6566,
      "title": "\"--lies, damned lies ... \" (Disraeli) / by J. W. B. Guise.",
      "author": "Guise, J. W. B.   ",
      "publisher": "University of New England,",
      "publisherDate": "[1975?]",
      "owningInstitution": "PUL",
      "customerCode": "PA",
      "collectionGroupDesignation": "Shared",
      "useRestriction": "No Restrictions",
      "barcode": "32101047813603",
      "summaryHoldings": "",
      "availability": "Available",
      "leaderMaterialType": "Monograph",
      "selected": false,
      "showItems": false,
      "selectAllItems": false,
      "searchItemResultRows": [],
      "itemId": 11625,
      "owningInstitutionBibId": "14334",
      "owningInstitutionHoldingsId": "15871",
      "owningInstitutionItemId": "14203",
      "requestPosition": null,
      "patronBarcode": null,
      "requestingInstitution": null,
      "deliveryLocation": null,
      "requestType": null,
      "requestNotes": null
    } ],
  "totalPageCount": 1,
  "totalBibRecordsCount": "1",
  "totalItemRecordsCount": "1",
  "totalRecordsCount": "1",
  "showTotalCount": false,
  "errorMessage": null
}
Alternate Response - Search
{
  "searchResultRows": [], // Response when no results are found.
  "totalPageCount": 0,
  "totalBibRecordsCount": "0",
  "totalItemRecordsCount": "0",
  "totalRecordsCount": "0",
  "showTotalCount": false,
  "errorMessage": null
}


  • No labels