Illrequests endpoint RFC

From Koha Wiki

Jump to: navigation, search

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_idillrequest_idill_request_id
borrowernumberborrowernumberpatron_id
biblio_idbiblio_id
branchcodebranchcodelibrary_id
statusstatus
placedplaceddate_placed
repliedreplieddate_replied
updatedupdatedtimestamp
completedcompleteddate_completed
mediummedium
accessurlaccessurlaccess_url
costcost
notesopacnotesopacopac_notes
notesstaffnotesstaffstaff_notes
orderidorderidorder_id
backendbackend

Notes