The Search API is used to search through the collections available in SCSB.
| Request - Search |
|---|
| API End Point : /searchService/search |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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": [
"PULInstitution1","CULInstitution2" // 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
} |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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": "PULInstitution",
"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
} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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": [
"PULInstitution1","CULInstitution2" // 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
} |
...