Cancel Hold of an Item

Owned by SK
Last updated: Sept 02, 2021 by Gunjan Bhardwaj
2 min read

The Cancel Hold of an Item is an internal call made by SCSB as part of the Cancel Request API. This is exposed as an API to ease the process of testing and will not be directly used by any actors outside of SCSB.

Request - Cancel Hold
{
  "bibId": "459389", // Owning Institution Bibliographic Id
  "itemBarcodes": [
    "32101043878741" // Item Barcode. Common across GFA LAS, ILS and SCSB.
  ],
  "itemOwningInstitution": "PUL", // Item owning Institution. Possible values are PUL, CUL, HL and NYPL.
  "patronIdentifier": "45678913", // The patron barcode issued by the partner ILS.
  "pickupLocation": "rcpcirc", // The pickup location detail used in the partner's ILS.
  "trackingId": "" //NYPL's ILS generated ID when the cancel is initiated on their side used as a reference to return response in SCSB.
}
Response - Cancel Hold
{
  "itemBarcode": "32101043878741",
  "itemOwningInstitution": "",
  "screenMessage": "Request cancelled.",
  "success": true,
  "esipDataIn": null,
  "esipDataOut": null,
  "available": false,
  "transactionDate": "12-Jan-2017 03:52:50",
  "institutionID": "",
  "patronIdentifier": "45678913",
  "titleIdentifier": "--Anche l'uomo doveva essere di ferro : classe e movimento operaio a Trieste nel secondo dopoguerra / O. Colummi ... [et al.] ; a cura di Luigi Ganapini.",
  "expirationDate": "05-Feb-2017 22:15:45",
  "pickupLocation": null,
  "queuePosition": null,
  "bibId": "459389",
  "trackingId": null,
  "updatedDate": null,
  "createdDate": null,
  "isbn": null,
  "lccn": "86213675"
}
Request - Cancel Hold (NYPL)
{
  "bibId": "", 
  "itemBarcodes": [
    "33433033691407" 
  "itemOwningInstitution": "NYPL", 
  "patronIdentifier": "23333097542730", 
  "pickupLocation": "", 
  "trackingId": "221"
}

trackingId in NYPL Request

The trackingId (221 in the above example) is got as a response during initiating the cancel hold in NYPL ILS (calling cancelRecapHoldRequest API in NYPL ILS). In practical scenarios where this API will be used, SCSB ensures the inclusion of the tracking id. While testing this API as a standalone, the tracking id must be generated by manually calling the NYPL ILS' API. More information here.

Response - Cancel Hold (NYPL)
{
  "itemBarcode": "33433033691407",
  "itemOwningInstitution": "NYPL",
  "screenMessage": "Successfully processed cancel hold request",
  "success": true,
  "esipDataIn": null,
  "esipDataOut": null,
  "available": false,
  "transactionDate": null,
  "institutionID": null,
  "patronIdentifier": "23333097542730",
  "titleIdentifier": null,
  "expirationDate": null,
  "pickupLocation": null,
  "queuePosition": null,
  "bibId": null,
  "trackingId": "221",
  "jobId": "1046587df2e952698",
  "updatedDate": null,
  "createdDate": "2017-01-17T05:33:13-05:00",
  "isbn": null,
  "lccn": null
}