Versions Compared

Key

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

Request

'bibliographicId' can either take in Bib Availability status API returns the availability statuses of items associated with the bibliographic record. Since it returns availability statuses of all items associated with a bib, it is likely to be used in partner ILS' Discovery systems to retrieve and display multiple item and their statuses in case of serials and multi volume monographs. The API also accepts both the owning institution's bibliographic record id or SCSB's bibliographic id.id (the id used internally in the partner's ILS) and the bibliographic id generated by SCSB. The institutionId value needs to mention which institution's bibliographicId is being passed.


Info
titleRequests prior to SCSB

Items that were requested and are out of ReCAP before the SCSB system went live are also marked as 'Not Available' by SCSB. This is done by translating GFA LAS' item statuses to SCSB's as defined in this sheet.


Code Block
languagejs
titleRequest - Bib Availability Status
linenumberstrue
{
  "bibliographicId": "773931", // Owning Institution's (CUL's) bibliographic record id id used internally in partner's ILS
  "institutionId": "CUL" // The owning institution's id. Possible values are PUL, CUL, NYPL, HL or SCSB.
}


Code Block
languagejs
titleRequest - Bib Availability Status
linenumberstrue
{
  "bibliographicId": "2590526", //SCSB's bibliographic record id
  "institutionId": "SCSB"
}

...

Code Block
languagejs
titleResponse - Bib Availability Status
linenumberstrue
[
  {
    "itemBarcode": "33433011172446",
    "itemAvailabilityStatus": "CU64297268Not Available", // Item is not in ReCAP facility
    "errorMessage": null
  },
  {
    "itemBarcode": "33433011172438",
    "itemAvailabilityStatus": "Available", // Item is in ReCAP facility
    "errorMessage": null
  }
]


Code Block
languagejs
titleAlternate Response - Bib Availability Status
linenumberstrue
[
  {
    "itemBarcode": null,
    "itemAvailabilityStatus": null,
    "errorMessage": "Bib Id doesn't exist in SCSB database." // Bibliographic record doesn't exist is SCSB
  }
]