Item types endpoint RFC
Jump to navigation
Jump to search
This RFC should be the basis for discussing the item_types endpoint. Work is being done in bug 34008
Use cases
The item_types could be used for integration with discovery systems, for displaying translated item type descriptions and for hiding items which have "hideinopac" set on the item type.
Actions and routes
The following table presents the current implementation, and the proposed changes.
Description | Action | Proposed path |
List item types | GET |
/item_types |
Item type object definition
DB schema | suggestion | Suggestions Katrin |
itemtype | item_type | |
parent_type | parent_type | |
description | description | |
rentalcharge | rentalcharge | rental_charge |
rentalcharge_daily | rentalcharge_daily | rental_charge_daily |
rentalcharge_daily_calendar | rentalcharge_daily_calendar | rental_charge_daily_calendar |
rentalcharge_hourly | rentalcharge_hourly | rental_charge_hourly |
rentalcharge_hourly_calendar | rentalcharge_hourly_calendar | rental_chargy_hourly_claendar |
defaultreplacecost | defaultreplacecost | replacement_cost_default |
processfee | processfee | replacement_processing_fee |
notforloan | notforloan | not_for_loan |
imageurl | imageurl | image_url |
summary | summary | |
checkinmsg | checkinmsg | checkin_message |
checkinmsgtype | checkinmsgtype | checkin_message_type |
sip_media_type | sip_media_type | sip_media_type |
hideinopac | hideinopac | hidden_in_opac |
searchcategory | searchcategory | search_group_category |
automatic_checkin | automatic_checkin | automatic_checkin |
- | translated_descriptions |
Item type translated description object definition
DB schema | suggestion |
lang | lang |
translation | translation |
Permissions
We use the same permission as needed for managing itemtypes in the staff interface, which is 'catalogue'.