RESTful Services

ReCAP middleware supports access to various functions via RESTful services.

• Live APIs would be available in this location after deployment - 

  Services	Consumer	URL	Status	Institution			Volume Constraints	Comments
  				PUL	CUL	NYPL
  Data Dump		<environment>:9093/swagger-ui/index.html
  Export Data Dump	Partners		Ready				< = 100 XMLs as HTML response
  Export Data Dump (with To date)	Internal		Ready				< = 100 XMLs as HTML response
  Purge
  Purge Email Addresses	Internal		Ready
  Purge Exception Requests	Internal		Ready
  Request
  Cancel Hold of an Item	Internal		Ready				1
  Cancel Request	Partners & ReCAP		Ready				1
  Check-In Item	Internal		Ready				1
  Check-Out Item	Internal		Ready				1
  Create Bibliographic record	Internal		Ready				1	NYPL is likely to maintain other partner's item information in their system.
  Hold Item	Internal		Ready				Unlimited
  Item Information	Internal		Ready				1
  Patron Information	Internal		Ready				1	Patron Validation is not performed for NYPL patrons in SCSB. This is done on NYPL's system.
  Recall	Internal		Ready				Unlimited
  Refile Item	ReCAP		Ready				Unlimited
  Request Item	Partners		Ready				Unlimited1	Cross partner borrowing by PUL and CUL patrons on NYPL items work provided the items they request are maintained in NYPL ILS locally.
  Validate Item Request Info	Internal		Ready				Unlimited1
  Search
  Search	Partners		Ready				Unlimited
  Collection
  Accession	ReCAP		Ready				10 items currently, can be scaled up
  Accession Batch	ReCAP		Ready				Unlimited
  Bib Availability Status	Partners		Ready				Unlimited
  Deaccession	Internal		Ready				1
  Item Availability Status	Partners		Ready				Unlimited
  Submit Collection Records	Partners		Ready				100 items currently, can be scaled up
  Transfer Holdings and Items	Partners		Ready				1

  • where, <environment> can be http://uat-recap.htcinc.com (or) http://tst-recap.htcinc.com
  • ¹  denotes it takes in multiple items but must belong to the same bibliographic record, have the same customer code and share the same availability status.
  • WIP denotes Work In Progress
  •  are for those APIs that are integrated with the respective ILS' services and ReCAP's GFA LAS' services.