Illrequests endpoint RFC

This RFC is a proposal to make some changes to this endpoint, to match the generally accepted criteria. No bug report has been filled for implementing it.

Actions and routes

The following table presents the current implementation, and the proposed changes.

Description	Action	Current path	Proposed path
List ILL requests	GET	/illrequests	/ill_requests
Add ILL request	POST	NOT IMPLEMENTED	/ill_requests
Get an ILL request	GET	NOT IMPLEMENTED	/ill_requests/{ill_request_id}
Overwrite an ILL request	PUT	NOT IMPLEMENTED	/ill_requests/{ill_request_id}
Cancel an ILL request	DELETE	NOT IMPLEMENTED	/ill_requests/{ill_request_id}
Partially update an ILL request	PATCH	NOT IMPLEMENTED	/ill_requests/{ill_request_id}

ILL request object definition

DB schema	Current API	josef_moravec
illrequest_id	illrequest_id	ill_request_id
borrowernumber	borrowernumber	patron_id
biblio_id	biblio_id
branchcode	branchcode	library_id
status	status
placed	placed	date_placed
replied	replied	date_replied
updated	updated	timestamp
completed	completed	date_completed
medium	medium
accessurl	accessurl	access_url
cost	cost
notesopac	notesopac	opac_notes
notesstaff	notesstaff	staff_notes
orderid	orderid	order_id
backend	backend

Discussion

+1 --Kfischer 17:05, 2 November 2019 (EDT)