gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Koha-clms/api/v1/swagger/definitions
History
Nick Clemens f1ca516b60
Bug 39829: Allow custom title in SIP responses 
This patch adds a custom aj_field_template to the sip accounts
This allows libraries to specify a template for the title (AJ) field in sip
messages

The template allows using item and biblio fields (item provides access to biblio. but we pass
both in order to makes the templates simpler

To test:
1 - Install patches
2 - updatedatabase, yarn build, restart_all
3 - Setup a sip account, KTD already has a sip patron, term1, you can use that
    don't add the aj_field_template yet
4 - Find or create a biblio with 245a and 245b like 245$aTitle : $bSubtitle and add item with TESTBARCODE
5 - From the command line:
    perl misc/sip_cli_emulator.pl -su term1 -sp term1 -l CPL -t CR -a localhost -p 6001 -m item_information --item TESTBARCODE
6 - Confirm AJ field shows "Title :" as expected
7 - Edit sip account, set aj_field_template to:
    [% biblio.title %] [% biblio.subtitle %] [% item.barcode %]
8 - Repeat the sip test
9 - Confirm you get the response like:
    Title : Subtitle TESTBARCODE
10 - Sign off!

Signed-off-by: Bob Bennhoff <bbennhoff@clicweb.org>
Signed-off-by: Paul Derscheid <paul.derscheid@lmscloud.de>
Signed-off-by: Pedro Amorim <pedro.amorim@openfifth.co.uk>
 		2026-09-03 10:56:52 +00:00
..
ISO18626 Bug 37762: ISO18626 REST API specs 2026-05-08 12:25:40 -06:00
account_line.yaml Bug 22421: (QA follow-up) Update API mapping and specs 2024-11-08 17:06:06 +01:00
action_log.yaml Bug 43119: Restore item and hold links to the log viewer 2026-07-27 12:13:00 +00:00
additional_content.yaml Bug 39900: Add translated_contents embed 2025-08-14 16:05:54 -06:00
advancededitormacro.yaml
…
allows_renewal.yaml
…
authorised_value.yaml Bug 32981: Add endpoint to get AV for given category 2023-03-02 12:00:10 -03:00
authorised_value_category.yaml Bug 28869: (RM follow-up) Add missing field in api definition 2024-05-17 14:39:54 +01:00
basket.yaml Bug 29668: Add API route to add a basket 2026-01-21 15:28:09 -07:00
booking.yaml Bug 40134: Implement optimal item selection for 'any item' bookings 2026-02-10 08:50:56 -07:00
booking_patch.yaml Bug 40134: Implement optimal item selection for 'any item' bookings 2026-02-10 08:50:56 -07:00
bundle_link.yaml Bug 29560: (follow-up) Split prepare and store logic 2024-07-15 11:04:05 +02:00
cash_register.yaml Bug 36481: (QA follow-up) Rename branch_default to library_default 2024-05-01 13:51:41 +01:00
cashup.yaml
…
checkout.yaml Bug 41889: Update API to allow for null patron_id to be returned when listing checkouts 2026-07-01 09:34:39 +00:00
checkout_availability.yaml Bug 23336: (follow-up) Add checkout_availability schema 2023-07-05 12:17:19 -03:00
checkouts.yaml
…
circ-rule-kind.yaml Bug 36641: Add endpoint for fetching circulation rules 2024-07-18 18:25:43 +02:00
circulation_rules.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
city.yaml
…
club_hold.yaml
…
club_hold_patron_hold.yaml
…
club_hold_patron_holds.yaml
…
club_holds.yaml
…
credit.yaml Bug 29453: (follow-up) Add tests and fix minimum amount in credit.yaml definition 2023-05-05 12:13:51 -03:00
debit.yaml Bug 22421: (QA follow-up) Update API mapping and specs 2024-11-08 17:06:06 +01:00
desk.yaml Bug 36480: Add GET /libraries/:library_id/desks 2024-04-26 18:06:10 +02:00
edifact_file.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_agreement.yaml Bug 40512: Add maxLength to erm agreements 2025-10-02 09:38:18 -06:00
erm_agreement_license.yaml
…
erm_agreement_period.yaml Bug 39438: Add additional fields support to ERM agreement periods 2026-01-30 10:54:10 -07:00
erm_agreement_relationship.yaml
…
erm_config.yaml Bug 33606: Add a erm/config route to retrieve the ERM config needed for the Vue app 2023-07-06 12:24:13 -03:00
erm_counter_file.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_counter_log.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_counter_registry.yaml Bug 35757: Add new fields to api definitions 2024-01-11 12:10:44 +01:00
erm_custom_report.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_default_usage_report.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_document.yaml
…
erm_eholdings_package.yaml Bug 37577: Add additional fields for ERM packages 2024-11-08 16:09:19 +01:00
erm_eholdings_package_agreement.yaml
…
erm_eholdings_resource.yaml
…
erm_eholdings_title.yaml Bug 40192: Add additional fields support to ERM titles 2026-01-22 09:25:57 -07:00
erm_license.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_license_agreement.yaml
…
erm_sushi_service.yaml Bug 39007: Update API spec and unit test 2025-01-31 15:57:32 +01:00
erm_usage_data_provider.yaml Bug 37856: Add service_platform field 2024-09-27 18:00:37 +02:00
erm_usage_database.yaml Bug 34587: Add list endpoints for usage_databases/items/platforms 2023-10-31 16:46:08 -03:00
erm_usage_item.yaml Bug 34587: Add list endpoints for usage_databases/items/platforms 2023-10-31 16:46:08 -03:00
erm_usage_mus.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_usage_platform.yaml Bug 34587: Add list endpoints for usage_databases/items/platforms 2023-10-31 16:46:08 -03:00
erm_usage_title.yaml Bug 34587: Move YOP to mus/yus instead of erm_usage_titles 2023-10-31 16:46:29 -03:00
erm_usage_yus.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
erm_user_role.yaml
…
error.yaml
…
extended_attribute_type.yaml Bug 35044: Add repetable to REST API spec 2024-08-23 18:21:25 +02:00
extended_attribute_value.yaml Bug 40541: Add missing new line at the end of files when missing 2025-07-31 12:42:09 -06:00
file_transport.yaml Bug 39190: Rename API from sftp_servers to file_transports 2025-09-19 13:23:25 -06:00
fund.yaml
…
hold.yaml Bug 37762: Circulation: Hook to holds 2026-05-08 12:25:43 -06:00
hold_group.yaml Bug 41956: Remove visual_hold_group_id 2026-05-06 15:21:00 -06:00
holds.yaml
…
identity_provider.yaml Bug 33859: Use the phrase 'Identity providers' instead of 'Authentication providers' 2023-06-05 14:36:03 -03:00
identity_provider_domain.yaml Bug 37711: API changes 2025-11-05 07:12:31 -07:00
ill_backend.yaml Bug 22440: Move backend statuses api endpoint 2023-05-05 09:13:43 -03:00
ill_backends.yaml
…
ill_batch.yaml Bug 30719: (QA follow-up) Pick better column names and cleanup 2023-10-17 14:45:23 -03:00
ill_batches.yaml Bug 30719: (QA follow-up) Rename illbatches endpoint to ill/batches 2023-10-17 14:45:20 -03:00
ill_batchstatus.yaml Bug 30719: (QA follow-up) Rename illbatchstatuses 2023-10-17 14:45:22 -03:00
ill_batchstatuses.yaml Bug 30719: (QA follow-up) Rename illbatchstatuses 2023-10-17 14:45:22 -03:00
ill_config.yaml Bug 42845: Add ILL config endpoint for Vue app 2026-07-27 15:53:48 +00:00
ill_request.yaml Bug 40504: Add 'managedby' to illrequests 2026-03-26 14:21:22 +01:00
ill_status.yaml Bug 22440: ILL API changes 2023-05-05 09:13:42 -03:00
import_batch_profile.yaml
…
import_batch_profiles.yaml
…
import_record_match.yaml
…
invoice.yaml
…
iso18626_request.yaml Bug 37762: Catalogue: Hook to biblios 2026-05-08 12:25:44 -06:00
iso18626_requesting_agency.yaml Bug 37762: ISO18626 KOHA classes 2026-05-08 12:25:41 -06:00
item.yaml Bug 17387: add deleted items restore api 2026-04-15 14:10:18 -06:00
item_group.yaml
…
item_type.yaml Bug 41649: Add option to set magnetic flag for item itemtypes 2026-08-06 16:07:33 +00:00
item_type_translated_description.yaml Bug 34008: Add REST endpoint for list of itemtypes 2023-11-01 17:23:14 -03:00
job.yaml Bug 39771: Make `data` attribute nullable for jobs 2025-05-09 09:12:06 +02:00
koha_version.yaml Bug 41107: Add /status/version API endpoint 2026-03-23 09:33:54 +01:00
library.yaml Bug 40433: Add missing maxLength to item, library and patron 2025-07-21 14:01:28 -06:00
list.yaml Bug 28965: Add /public/lists 2024-11-08 16:09:21 +01:00
merge_biblios.yaml Bug 33036: REST API: Merge biblio records implements merging of records 2024-03-18 11:03:39 +01:00
order.yaml Bug 8179: Receive multiple orders 2023-05-15 08:53:47 -03:00
order_claim.yaml Bug 39830: Add order claim object definition 2025-09-29 14:02:21 -06:00
patron.yaml Bug 26355: Update the API specs 2026-05-01 09:29:59 -06:00
patron_account_credit.yaml
…
patron_balance.yaml
…
patron_category.yaml Bug 26355: Update the API specs 2026-05-01 09:29:59 -06:00
patron_extended_attribute.yaml
…
patron_self_renewal.yaml Bug 26355: Update the API specs 2026-05-01 09:29:59 -06:00
preservation_config.yaml Bug 30708: Do not allow non-authorised users to edit the settings 2023-10-18 15:42:01 -03:00
preservation_processing.yaml Bug 33547: Add print slip 2023-10-23 11:33:51 -03:00
preservation_processing_attribute.yaml Bug 30708: REST API specs 2023-10-18 15:41:40 -03:00
preservation_train.yaml Bug 30708: Fix API specs 2023-10-20 10:00:58 -03:00
preservation_train_item.yaml Bug 35230: (bug 30708 follow-up) fix description for catalogue_item 2023-11-03 12:04:47 -03:00
quote.yaml
…
recall.yaml Bug 35967: (QA follow-up) `status` is not nullable 2024-04-19 19:54:44 +02:00
recalls.yaml Bug 35967: Add REST API endpoint to list patron recalls 2024-04-19 19:54:43 +02:00
record_source.yaml Bug 35380: Change record sources to by systemdefined 2026-03-26 09:46:15 +01:00
renewal.yaml Bug 30642: Make renewal_type an enum in spec and add test 2023-02-10 11:08:00 -03:00
renewals.yaml
…
return_claim.yaml
…
rota.yaml Bug 35430: Add rota endpoints for stockrotation 2024-06-28 13:49:26 +02:00
search_filter.yaml
…
sip2_account.yaml Bug 39829: Allow custom title in SIP responses 2026-09-03 10:56:52 +00:00
sip2_institution.yaml Bug 37893: REST API specs 2025-11-18 11:20:44 -07:00
sip2_system_preference_override.yaml Bug 37893: SIP2 System preference overrides 2025-11-18 11:20:56 -07:00
smtp_server.yaml
…
suggestion.yaml Bug 33430: (follow-up) Fix API spec terminology 2025-05-19 18:54:23 +02:00
syspref.yaml Bug 41994: Implement /sysprefs route to list system preferences 2026-04-15 11:37:05 -06:00
ticket.yaml Bug 35657: Add support for assignee_id to ticket_updates endpoint 2024-05-02 15:03:35 +02:00
ticket_update.yaml Bug 35657: Add support for assignee_id to ticket_updates endpoint 2024-05-02 15:03:35 +02:00
transfer_limit.yaml
…
vendor.yaml Bug 38207: Update UI to use new field 2026-01-22 09:26:04 -07:00
vendor_alias.yaml Bug 39838: Add `vendor_alias` definition in swagger 2025-05-13 18:47:03 +02:00
vendor_interface.yaml Bug 39837: Add definition in swagger 2025-05-13 18:47:06 +02:00
vendor_issue.yaml Bug 33105: Fix vendor api spec 2023-07-20 10:59:29 -03:00
vendors_config.yaml Bug 38208: Provide a link from vendors to ERM 2025-11-03 14:13:34 -07:00