API v0.1 - NYPL/recap-hold-request-service GitHub Wiki

Endpoints

POST /api/v0.1/recap/hold-requests

Request Body	Type	Description
ReCAP Hold Request Object	JSON Object	Required. Basic data sent to Sierra ILS for post-processing.

Example: { "owningInstitutionId": "PUL", "itemBarcode": "3xxx",...

RecapHoldRequest Object {}

Property	Type	Notes
owningInstitutionId	string	Required.
itemBarcode	string	Required.
patronBarcode	string	Required.
description	object	Optional.

Description object {}

Property	Type	Notes
title	string	Optional.
author	string	Optional.
callNumber	string	Optional.

POST /api/v0.1/recap/cancel-hold-requests

Request Body	Type	Description
ReCAP Cancel Hold Request Object	JSON Object	Required. Basic data sent to cancel a hold request in the Sierra ILS.

RecapCancelHoldRequest Object {}

Property	Type	Notes
trackingId	string	Required.
owningInstitutionId	string	Required.
itemBarcode	string	Required.
patronBarcode	string	Required.