Patrons extended attributes endpoint RFC

From Koha Wiki
Jump to navigation Jump to search

This RFC should be the basis for bug 23666 and related bug reports that could need to be filed.

Actions and routes

GET /patrons/:patron_id/extended_attributes POST /patrons/:patron_id/extended_attributes PUT /patrons/:patron_id/extended_attributes <- to overwrite them all DELETE /patrons/:patron_id/extended_attributes/:extended_attribute_id

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

Description Action Path
List patron's extended attributes
 GET
 /patrons/{patron_id}/extended_attributes
Add an extended attribute to a patron
 POST
 /patrons/{patron_id}/extended_attributes
Overwrite the patron's extended attributes
 PUT
 /patrons/{patron_id}/extended_attributes
Delete an extended attribute
 DELETE
 /patrons/{patron_id}/extended_attributes/{extended_attribute_id}

Extended attribute object

DB schema API
code type
attribute value
borrowernumber REMOVED