Versions Compared

Key

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

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

    Request - Search 
    API End Point : /searchService/search


Code Block
languagejs
titleRequest - Search
linenumberstrue
{
  "deleted": false, // Valid parameters are "true" and "false". It is a flag that is marked "true" when the item is deaccessioned.
  "fieldValue": "",
  "fieldName": "", // Valid parameters are "Author_search", "Title_search", "TitleStartsWith", "Publisher", "PublicationPlace", "PublicationDate", "Subject", "ISBN", "ISSN", "OCLCNumber", "Notes", "CustomerCode", "CallNumber_search", "Barcode"
  "owningInstitutions": [
    "Institution1","Institution2" // 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 "NotAvailable". 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
}

...