The Hold Item API call is an internal call made by SCSB to the partner's ILS to place a hold request as part of the request API workflow. The API call uses the SIP protocol to communicate with Princeton and Columbia ILS. In case of NYPL, the ILS' (Sierra) API is initially invoked and hence is not subsequently invoked as part of the request workflow.

Request - Hold Item

{
 "author": "", // Author information of the bibliographic record.
 "bibId": "459389", // Bibliographic Id of the bibliographic record.
 "callNumber": "", // Call number details to ease process of retrieval.
 "expirationDate": "20170205    221545", // Expiration date passed to the ILS' hold API. Usually 6 months for PUL and CUL and 1 year for NYPL.
 "itemBarcodes": [
   "32101043878741" // Item Barcode. Common across Storage Location IMS System, ILS and SCSB
 ],
 "itemOwningInstitution": "Institution", // Item owning institution. Possible values are PUL, CUL or NYPL.
 "patronIdentifier": "45678913", // Patron Barcode assigned to the patron by the partner institution.
 "pickupLocation": "rcpcirc", // Pickup location as expected by the ILS' API.
 "title": "", // This is used to send titles to use during creation of temporary records.
 "trackingId": "" // Institution's ILS generated ID initiated on their side while placing hold used as a reference to return response in SCSB.
}

Response - Hold Item

{
  "itemBarcode": "32101043878741",
  "itemOwningInstitution": "",
  "screenMessage": "Request placed.",
  "success": true,
  "available": true,
  "transactionDate": "12-Jan-2017 03:50:03",
  "institutionID": "",
  "patronIdentifier": "45678913",
  "titleIdentifier": null,
  "expirationDate": "05-Feb-2017 22:15:45",
  "pickupLocation": null,
  "queuePosition": null,
  "bibId": "459389",
  "trackingId": null,
  "updatedDate": null,
  "createdDate": null,
  "isbn": null,
  "lccn": "86213675"
}