6 $ref: ./definitions/account_line.yaml
8 $ref: ./definitions/advancededitormacro.yaml
10 $ref: ./definitions/allows_renewal.yaml
12 $ref: ./definitions/authorised_value.yaml
13 authorised_value_category:
14 $ref: ./definitions/authorised_value_category.yaml
16 "$ref": ./definitions/identity_provider.yaml
17 identity_provider_domain:
18 "$ref": ./definitions/identity_provider_domain.yaml
20 $ref: ./definitions/basket.yaml
22 $ref: ./definitions/bundle_link.yaml
24 $ref: ./definitions/cashup.yaml
26 $ref: ./definitions/checkout.yaml
28 $ref: ./definitions/checkouts.yaml
29 checkout_availability:
30 $ref: ./definitions/checkout_availability.yaml
32 $ref: ./definitions/circ-rule-kind.yaml
34 $ref: ./definitions/city.yaml
36 $ref: ./definitions/credit.yaml
38 $ref: ./definitions/debit.yaml
40 $ref: ./definitions/erm_config.yaml
42 $ref: ./definitions/erm_agreement.yaml
44 $ref: ./definitions/erm_counter_file.yaml
46 $ref: ./definitions/erm_counter_log.yaml
48 $ref: ./definitions/erm_custom_report.yaml
49 erm_default_usage_report:
50 $ref: ./definitions/erm_default_usage_report.yaml
52 $ref: ./definitions/erm_eholdings_title.yaml
53 erm_eholdings_package:
54 $ref: ./definitions/erm_eholdings_package.yaml
55 erm_eholdings_resource:
56 $ref: ./definitions/erm_eholdings_resource.yaml
58 $ref: ./definitions/erm_license.yaml
59 erm_usage_data_provider:
60 $ref: ./definitions/erm_usage_data_provider.yaml
62 $ref: ./definitions/erm_usage_database.yaml
64 $ref: ./definitions/erm_usage_item.yaml
66 $ref: ./definitions/erm_usage_mus.yaml
68 $ref: ./definitions/erm_usage_platform.yaml
70 $ref: ./definitions/erm_usage_title.yaml
72 $ref: ./definitions/erm_usage_yus.yaml
74 $ref: ./definitions/error.yaml
76 $ref: ./definitions/fund.yaml
78 $ref: ./definitions/hold.yaml
80 $ref: ./definitions/holds.yaml
82 $ref: ./definitions/ill_backend.yaml
84 $ref: ./definitions/ill_backends.yaml
86 $ref: ./definitions/ill_status.yaml
88 $ref: ./definitions/ill_request.yaml
90 $ref: ./definitions/ill_batch.yaml
92 $ref: ./definitions/ill_batches.yaml
94 $ref: ./definitions/ill_batchstatus.yaml
96 $ref: ./definitions/ill_batchstatuses.yaml
98 $ref: ./definitions/import_batch_profile.yaml
99 import_batch_profiles:
100 $ref: ./definitions/import_batch_profiles.yaml
102 $ref: ./definitions/import_record_match.yaml
104 $ref: ./definitions/invoice.yaml
106 $ref: ./definitions/item.yaml
108 $ref: ./definitions/item_group.yaml
110 $ref: ./definitions/job.yaml
112 $ref: ./definitions/library.yaml
114 $ref: ./definitions/order.yaml
116 $ref: ./definitions/patron.yaml
117 patron_account_credit:
118 $ref: ./definitions/patron_account_credit.yaml
120 $ref: ./definitions/patron_balance.yaml
121 patron_extended_attribute:
122 $ref: ./definitions/patron_extended_attribute.yaml
124 $ref: ./definitions/preservation_config.yaml
126 $ref: ./definitions/preservation_train.yaml
127 preservation_train_item:
128 $ref: ./definitions/preservation_train_item.yaml
129 preservation_processing:
130 $ref: ./definitions/preservation_processing.yaml
132 $ref: ./definitions/quote.yaml
134 $ref: ./definitions/renewal.yaml
136 $ref: ./definitions/renewals.yaml
138 $ref: ./definitions/return_claim.yaml
140 $ref: ./definitions/search_filter.yaml
142 $ref: ./definitions/smtp_server.yaml
144 $ref: ./definitions/suggestion.yaml
146 $ref: ./definitions/ticket.yaml
148 $ref: ./definitions/ticket_update.yaml
150 $ref: ./definitions/transfer_limit.yaml
152 $ref: ./definitions/vendor.yaml
154 $ref: ./definitions/vendor_issue.yaml
156 /acquisitions/baskets/managers:
157 $ref: paths/acquisitions_baskets.yaml#/~1acquisitions~1baskets~1managers
159 $ref: ./paths/acquisitions_funds.yaml#/~1acquisitions~1funds
160 /acquisitions/funds/owners:
161 $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds~1owners
162 /acquisitions/funds/users:
163 $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds~1users
164 /acquisitions/orders:
165 $ref: ./paths/acquisitions_orders.yaml#/~1acquisitions~1orders
166 "/acquisitions/orders/{order_id}":
167 $ref: "./paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}"
168 /acquisitions/vendors:
169 $ref: ./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
170 "/acquisitions/vendors/{vendor_id}":
171 $ref: "./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}"
172 "/acquisitions/vendors/{vendor_id}/issues":
173 $ref: "./paths/acquisitions_vendor_issues.yaml#/~1acquisitions~1vendors~1{vendor_id}~1issues"
174 /advanced_editor/macros:
175 $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros
176 /advanced_editor/macros/shared:
177 $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared
179 $ref: ./paths/search_filters.yaml#/~1search_filters
180 "/search_filters/{search_filter_id}":
181 $ref: "./paths/search_filters.yaml#/~1search_filters~1{search_filter_id}"
182 "/advanced_editor/macros/shared/{advancededitormacro_id}":
183 $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}"
184 "/advanced_editor/macros/{advancededitormacro_id}":
185 $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}"
186 "/article_requests/{article_request_id}":
187 $ref: "./paths/article_requests.yaml#/~1article_requests~1{article_request_id}"
188 /auth/otp/token_delivery:
189 $ref: paths/auth.yaml#/~1auth~1otp~1token_delivery
190 "/auth/password/validation":
191 $ref: "./paths/auth.yaml#/~1auth~1password~1validation"
192 /auth/two-factor/registration:
193 $ref: paths/auth.yaml#/~1auth~1two-factor~1registration
194 /auth/two-factor/registration/verification:
195 $ref: paths/auth.yaml#/~1auth~1two-factor~1registration~1verification
196 /auth/identity_providers:
197 $ref: paths/auth.yaml#/~1auth~1identity_providers
198 "/auth/identity_providers/{identity_provider_id}":
199 $ref: paths/auth.yaml#/~1auth~1identity_providers~1{identity_provider_id}
200 "/auth/identity_providers/{identity_provider_id}/domains":
201 $ref: paths/auth.yaml#/~1auth~1identity_providers~1{identity_provider_id}~1domains
202 "/auth/identity_providers/{identity_provider_id}/domains/{identity_provider_domain_id}":
203 $ref: paths/auth.yaml#/~1auth~1identity_providers~1{identity_provider_id}~1domains~1{identity_provider_domain_id}
204 /authorised_value_categories:
205 $ref: paths/authorised_value_categories.yaml#/~1authorised_value_categories
206 "/authorised_value_categories/{authorised_value_category_name}/authorised_values":
207 $ref: "./paths/authorised_values.yaml#/~1authorised_value_categories~1{authorised_value_category_name}~1authorised_values"
209 $ref: paths/authorities.yaml#/~1authorities
210 "/authorities/{authority_id}":
211 $ref: paths/authorities.yaml#/~1authorities~1{authority_id}
213 $ref: "./paths/biblios.yaml#/~1biblios"
214 "/biblios/{biblio_id}":
215 $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}"
216 "/biblios/{biblio_id}/checkouts":
217 $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts"
218 "/biblios/{biblio_id}/items":
219 $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1items"
220 "/biblios/{biblio_id}/items/{item_id}":
221 $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1items~1{item_id}"
222 "/biblios/{biblio_id}/pickup_locations":
223 $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations"
224 "/biblios/{biblio_id}/item_groups":
225 $ref: "./paths/biblios_item_groups.yaml#/~1biblios~1{biblio_id}~1item_groups"
226 "/biblios/{biblio_id}/item_groups/{item_group_id}":
227 $ref: "./paths/biblios_item_groups.yaml#/~1biblios~1{biblio_id}~1item_groups~1{item_group_id}"
228 "/biblios/{biblio_id}/item_groups/{item_group_id}/items":
229 $ref: "./paths/biblios_item_groups.yaml#/~1biblios~1{biblio_id}~1item_groups~1{item_group_id}~1items"
230 "/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}":
231 $ref: "./paths/biblios_item_groups.yaml#/~1biblios~1{biblio_id}~1item_groups~1{item_group_id}~1items~1{item_id}"
232 "/cash_registers/{cash_register_id}/cashups":
233 $ref: "./paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups"
234 "/cashups/{cashup_id}":
235 $ref: "./paths/cash_registers.yaml#/~1cashups~1{cashup_id}"
237 $ref: ./paths/checkouts.yaml#/~1checkouts
238 "/checkouts/{checkout_id}":
239 $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
240 "/checkouts/{checkout_id}/allows_renewal":
241 $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
242 "/checkouts/{checkout_id}/renewals":
243 $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewals"
244 "/checkouts/{checkout_id}/renewal":
245 $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
246 "/checkouts/availability":
247 $ref: "./paths/checkouts.yaml#/~1checkouts~1availability"
248 /circulation-rules/kinds:
249 $ref: ./paths/circulation-rules.yaml#/~1circulation-rules~1kinds
251 $ref: ./paths/cities.yaml#/~1cities
253 $ref: "./paths/cities.yaml#/~1cities~1{city_id}"
254 "/clubs/{club_id}/holds":
255 $ref: "./paths/clubs.yaml#/~1clubs~1{club_id}~1holds"
256 /config/smtp_servers:
257 $ref: ./paths/config_smtp_servers.yaml#/~1config~1smtp_servers
258 "/config/smtp_servers/{smtp_server_id}":
259 $ref: "./paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}"
261 $ref: ./paths/erm_config.yaml#/~1erm~1config
263 $ref: ./paths/erm_agreements.yaml#/~1erm~1agreements
264 "/erm/agreements/{agreement_id}":
265 $ref: "./paths/erm_agreements.yaml#/~1erm~1agreements~1{agreement_id}"
266 "/erm/documents/{document_id}/file/content":
267 $ref: "./paths/erm_documents.yaml#/~1erm~1documents~1{document_id}~1file~1content"
269 $ref: ./paths/erm_counter_files.yaml#/~1erm~1counter_files
270 "/erm/counter_files/{erm_counter_files_id}":
271 $ref: "./paths/erm_counter_files.yaml#/~1erm~1counter_files~1{erm_counter_files_id}"
272 "/erm/counter_files/{erm_counter_files_id}/file/content":
273 $ref: "./paths/erm_counter_files.yaml#/~1erm~1counter_files~1{erm_counter_files_id}~1file~1content"
274 /erm/default_usage_reports:
275 $ref: ./paths/erm_default_usage_reports.yaml#/~1erm~1default_usage_reports
276 "/erm/default_usage_reports/{erm_default_usage_report_id}":
277 $ref: "./paths/erm_default_usage_reports.yaml#/~1erm~1default_usage_reports~1{erm_default_usage_report_id}"
278 "/erm/eholdings/{provider}/titles":
279 $ref: "./paths/erm_eholdings_titles.yaml#/~1erm~1eholdings~1{provider}~1titles"
280 /erm/eholdings/local/titles/import:
281 $ref: ./paths/erm_eholdings_titles.yaml#/~1erm~1eholdings~1local~1titles~1import
282 "/erm/eholdings/{provider}/titles/{title_id}":
283 $ref: "./paths/erm_eholdings_titles.yaml#/~1erm~1eholdings~1{provider}~1titles~1{title_id}"
284 "/erm/eholdings/{provider}/titles/{title_id}/resources":
285 $ref: "./paths/erm_eholdings_titles_resources.yaml#/~1erm~1eholdings~1{provider}~1titles~1{title_id}~1resources"
286 "/erm/eholdings/{provider}/packages":
287 $ref: "./paths/erm_eholdings_packages.yaml#/~1erm~1eholdings~1{provider}~1packages"
288 "/erm/eholdings/{provider}/resources":
289 $ref: "./paths/erm_eholdings_resources.yaml#/~1erm~1eholdings~1{provider}~1resources"
290 "/erm/eholdings/{provider}/resources/{resource_id}":
291 $ref: "./paths/erm_eholdings_resources.yaml#/~1erm~1eholdings~1{provider}~1resources~1{resource_id}"
292 "/erm/eholdings/{provider}/packages/{package_id}":
293 $ref: "./paths/erm_eholdings_packages.yaml#/~1erm~1eholdings~1{provider}~1packages~1{package_id}"
294 "/erm/eholdings/{provider}/packages/{package_id}/resources":
295 $ref: "./paths/erm_eholdings_packages_resources.yaml#/~1erm~1eholdings~1{provider}~1packages~1{package_id}~1resources"
296 "/erm/eUsage/monthly_report/{data_type}":
297 $ref: "./paths/erm_custom_reports.yaml#/~1erm~1eUsage~1monthly_report~1{data_type}"
298 "/erm/eUsage/yearly_report/{data_type}":
299 $ref: "./paths/erm_custom_reports.yaml#/~1erm~1eUsage~1yearly_report~1{data_type}"
300 "/erm/eUsage/metric_types_report/{data_type}":
301 $ref: "./paths/erm_custom_reports.yaml#/~1erm~1eUsage~1metric_types_report~1{data_type}"
302 "/erm/eUsage/provider_rollup_report/{data_type}":
303 $ref: "./paths/erm_custom_reports.yaml#/~1erm~1eUsage~1provider_rollup_report~1{data_type}"
305 $ref: ./paths/erm_licenses.yaml#/~1erm~1licenses
306 "/erm/licenses/{license_id}":
307 $ref: "./paths/erm_licenses.yaml#/~1erm~1licenses~1{license_id}"
308 /erm/usage_data_providers:
309 $ref: ./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers
310 "/erm/usage_data_providers/{erm_usage_data_provider_id}":
311 $ref: "./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers~1{erm_usage_data_provider_id}"
312 "/erm/usage_data_providers/{erm_usage_data_provider_id}/run":
313 $ref: "./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers~1{erm_usage_data_provider_id}~1run"
314 "/erm/usage_data_providers/{erm_usage_data_provider_id}/test_connection":
315 $ref: "./paths/erm_usage_data_providers.yaml#/~1erm~1usage_data_providers~1{erm_usage_data_provider_id}~1test_connection"
316 /erm/usage_databases:
317 $ref: ./paths/erm_usage_databases.yaml#/~1erm~1usage_databases
319 $ref: ./paths/erm_usage_items.yaml#/~1erm~1usage_items
320 /erm/usage_platforms:
321 $ref: ./paths/erm_usage_platforms.yaml#/~1erm~1usage_platforms
323 $ref: ./paths/erm_usage_titles.yaml#/~1erm~1usage_titles
325 $ref: ./paths/erm_users.yaml#/~1erm~1users
327 $ref: ./paths/holds.yaml#/~1holds
329 $ref: "./paths/holds.yaml#/~1holds~1{hold_id}"
330 "/holds/{hold_id}/pickup_location":
331 $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location"
332 "/holds/{hold_id}/pickup_locations":
333 $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations"
334 "/holds/{hold_id}/priority":
335 $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1priority"
336 "/holds/{hold_id}/suspension":
337 $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1suspension"
339 $ref: ./paths/ill_backends.yaml#/~1ill~1backends
340 "/ill/backends/{ill_backend_id}":
341 $ref: "./paths/ill_backends.yaml#/~1ill~1backends~1{ill_backend_id}"
343 $ref: ./paths/ill_requests.yaml#/~1ill~1requests
345 $ref: ./paths/ill_batches.yaml#/~1ill~1batches
346 "/ill/batches/{ill_batch_id}":
347 $ref: "./paths/ill_batches.yaml#/~1ill~1batches~1{ill_batch_id}"
349 $ref: ./paths/ill_batchstatuses.yaml#/~1ill~1batchstatuses
350 "/ill/batchstatuses/{ill_batchstatus_code}":
351 $ref: "./paths/ill_batchstatuses.yaml#/~1ill~1batchstatuses~1{ill_batchstatus_code}"
352 "/import_batches/{import_batch_id}/records/{import_record_id}/matches/chosen":
353 $ref: "./paths/import_batches.yaml#/~1import_batches~1{import_batch_id}~1records~1{import_record_id}~1matches~1chosen"
354 /import_batch_profiles:
355 $ref: ./paths/import_batch_profiles.yaml#/~1import_batch_profiles
356 "/import_batch_profiles/{import_batch_profile_id}":
357 $ref: "./paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}"
359 $ref: ./paths/items.yaml#/~1items
361 $ref: "./paths/items.yaml#/~1items~1{item_id}"
362 "/items/{item_id}/bundled_items":
363 $ref: ./paths/items.yaml#/~1items~1{item_id}~1bundled_items
364 "/items/{item_id}/bundled_items/{bundled_item_id}":
365 $ref: ./paths/items.yaml#/~1items~1{item_id}~1bundled_items~1{bundled_item_id}
366 "/items/{item_id}/pickup_locations":
367 $ref: "./paths/items.yaml#/~1items~1{item_id}~1pickup_locations"
369 $ref: ./paths/jobs.yaml#/~1jobs
371 $ref: "./paths/jobs.yaml#/~1jobs~1{job_id}"
373 $ref: ./paths/libraries.yaml#/~1libraries
374 "/libraries/{library_id}":
375 $ref: "./paths/libraries.yaml#/~1libraries~1{library_id}"
376 "/oauth/login/{provider_code}/{interface}":
377 $ref: ./paths/oauth.yaml#/~1oauth~1login~1{provider_code}~1{interface}
379 $ref: ./paths/oauth.yaml#/~1oauth~1token
381 $ref: ./paths/patrons.yaml#/~1patrons
382 "/patrons/{patron_id}":
383 $ref: "./paths/patrons.yaml#/~1patrons~1{patron_id}"
384 "/patrons/{patron_id}/account":
385 $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account"
386 "/patrons/{patron_id}/account/credits":
387 $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits"
388 "/patrons/{patron_id}/account/debits":
389 $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1debits"
390 "/patrons/{patron_id}/extended_attributes":
391 $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes"
392 "/patrons/{patron_id}/extended_attributes/{extended_attribute_id}":
393 $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}"
394 "/patrons/{patron_id}/holds":
395 $ref: "./paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds"
396 "/patrons/{patron_id}/password":
397 $ref: "./paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password"
398 "/patrons/{patron_id}/password/expiration_date":
399 $ref: "./paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password~1expiration_date"
400 /preservation/config:
401 $ref: ./paths/preservation_config.yaml#/~1preservation~1config
402 /preservation/trains:
403 $ref: ./paths/preservation_trains.yaml#/~1preservation~1trains
404 "/preservation/trains/{train_id}":
405 $ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}"
406 "/preservation/trains/{train_id}/items":
407 $ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items"
408 "/preservation/trains/{train_id}/items/batch":
409 $ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items~1batch"
410 "/preservation/trains/{train_id}/items/{train_item_id}":
411 $ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items~1{train_item_id}"
412 "/preservation/trains/{train_id}/items/{train_item_id}/copy":
413 $ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items~1{train_item_id}~1copy"
414 /preservation/processings:
415 $ref: ./paths/preservation_processings.yaml#/~1preservation~1processings
416 "/preservation/processings/{processing_id}":
417 $ref: "./paths/preservation_processings.yaml#/~1preservation~1processings~1{processing_id}"
418 /preservation/waiting-list/items:
419 $ref: ./paths/preservation_waiting_list.yaml#/~1preservation~1waiting-list~1items
420 "/preservation/waiting-list/items/{item_id}":
421 $ref: "./paths/preservation_waiting_list.yaml#/~1preservation~1waiting-list~1items~1{item_id}"
422 "/public/biblios/{biblio_id}":
423 $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}"
424 "/public/checkouts/availability":
425 $ref: ./paths/checkouts.yaml#/~1public~1checkouts~1availability
427 $ref: "./paths/items.yaml#/~1public~1items"
428 "/public/biblios/{biblio_id}/items":
429 $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items"
430 "/public/biblios/{biblio_id}/ratings":
431 $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1ratings"
433 $ref: ./paths/libraries.yaml#/~1public~1libraries
434 "/public/libraries/{library_id}":
435 $ref: "./paths/libraries.yaml#/~1public~1libraries~1{library_id}"
436 "/public/oauth/login/{provider_code}/{interface}":
437 $ref: ./paths/public_oauth.yaml#/~1public~1oauth~1login~1{provider_code}~1{interface}
438 "/public/patrons/{patron_id}/article_requests/{article_request_id}":
439 $ref: "./paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}"
440 "/public/patrons/{patron_id}/checkouts":
441 $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1checkouts"
442 "/public/patrons/{patron_id}/guarantors/can_see_charges":
443 $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges"
444 "/public/patrons/{patron_id}/guarantors/can_see_checkouts":
445 $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"
446 "/public/patrons/{patron_id}/holds/{hold_id}":
447 $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1holds~1{hold_id}"
448 "/public/patrons/{patron_id}/password":
449 $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password"
451 $ref: "./paths/tickets.yaml#/~1public~1tickets"
453 $ref: ./paths/quotes.yaml#/~1quotes
454 "/quotes/{quote_id}":
455 $ref: "./paths/quotes.yaml#/~1quotes~1{quote_id}"
457 $ref: ./paths/return_claims.yaml#/~1return_claims
458 "/return_claims/{claim_id}":
459 $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}"
460 "/return_claims/{claim_id}/notes":
461 $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes"
462 "/return_claims/{claim_id}/resolve":
463 $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve"
464 "/rotas/{rota_id}/stages/{stage_id}/position":
465 $ref: "./paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position"
467 $ref: ./paths/suggestions.yaml#/~1suggestions
468 "/suggestions/{suggestion_id}":
469 $ref: "./paths/suggestions.yaml#/~1suggestions~1{suggestion_id}"
470 /suggestions/managers:
471 $ref: paths/suggestions.yaml#/~1suggestions~1managers
473 $ref: "./paths/tickets.yaml#/~1tickets"
474 "/tickets/{ticket_id}":
475 $ref: "./paths/tickets.yaml#/~1tickets~1{ticket_id}"
476 "/tickets/{ticket_id}/updates":
477 $ref: "./paths/tickets.yaml#/~1tickets~1{ticket_id}~1updates"
479 $ref: ./paths/transfer_limits.yaml#/~1transfer_limits
480 /transfer_limits/batch:
481 $ref: ./paths/transfer_limits.yaml#/~1transfer_limits~1batch
482 "/transfer_limits/{limit_id}":
483 $ref: "./paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}"
485 advancededitormacro_id_pp:
486 description: Advanced editor macro internal identifier
488 name: advancededitormacro_id
492 description: Agreement internal identifier
497 agreement_period_id_pp:
498 description: Agreement period internal identifier
500 name: agreement_period_id
503 authorised_value_id_pp:
504 description: Authorised value internal identifier
506 name: authorised_value_id
510 description: Authority identifier
515 authority_type_header:
516 description: Authority type code. Use when content type is not application/json
517 name: x-authority-type
522 description: Framework id. Use when content type is not application/json
528 description: March schema. One of MARC21 or UNIMARC
529 name: x-record-schema
536 confirm_not_duplicate_header:
537 description: Confirm the posted element is not a duplicate
538 name: x-confirm-not-duplicate
542 identity_provider_id_pp:
543 description: Identity provider internal identifier
545 name: identity_provider_id
548 identity_provider_domain_id_pp:
549 description: Identity provider domain internal identifier
551 name: identity_provider_domain_id
555 description: Record internal identifier
560 candidate_match_id_pp:
561 description: Internal import record match identifier
563 name: candidate_match_id
567 description: Cash register internal identifier
569 name: cash_register_id
573 description: Cashup internal identifier
579 description: Internal checkout identifier
585 description: City internal identifier
591 description: Internal club identifier
596 eholdings_title_id_pp:
597 description: Title internal identifier
602 eholdings_package_id_pp:
603 description: Package internal identifier
608 eholdings_resource_id_pp:
609 description: Resource internal identifier
614 erm_counter_files_id_pp:
615 description: ERM counter_files internal identifier
617 name: erm_counter_files_id
620 erm_counter_log_id_pp:
621 description: ERM counter_log internal identifier
623 name: erm_counter_log_id
626 erm_default_usage_report_id_pp:
627 description: ERM default_usage_report internal identifier
629 name: erm_default_usage_report_id
632 erm_usage_data_provider_id_pp:
633 description: ERM usage_data_provider internal identifier
635 name: erm_usage_data_provider_id
639 description: ERM custom report data type
651 description: Internal hold identifier
657 description: Internal ILL batch identifier
662 ill_batchstatus_code_pp:
663 description: Internal ILL batch status identifier
665 name: ill_batchstatus_code
668 import_batch_profile_id_pp:
669 description: Internal profile identifier
671 name: import_batch_profile_id
675 description: Internal import record identifier
677 name: import_record_id
681 description: Internal item identifier
687 description: Internal item identifier
692 description: Job internal identifier
698 description: Internal library identifier
704 description: License internal identifier
710 description: Matching criteria
721 collectionFormat: csv
722 description: Sorting criteria
730 description: Internal order identifier
736 description: "Page number, for paginated object listing"
742 description: Internal patron identifier
748 description: Internal patron identifier
753 description: "Page size, for paginated object listing"
758 preservation_processing_id_pp:
759 description: processing internal identifier
764 preservation_train_id_pp:
765 description: train internal identifier
770 preservation_train_item_id_pp:
771 description: train item internal identifier
777 description: Query filter sent through request"s body
784 description: Query filter sent as a request parameter
791 collectionFormat: multi
793 description: Quote internal identifier
799 description: Request id header
801 name: x-koha-request-id
805 name: search_filter_id
807 description: Search filter internal identifier
811 description: Item was seen flag
817 description: SMTP server internal identifier
823 description: Internal suggestion identifier
829 description: Internal ticket identifier
834 transfer_limit_id_pp:
835 description: Internal transfer limit identifier
841 description: Vendor id
851 url: http://www.gnu.org/licenses/gpl.txt
853 name: Koha Development Team
854 url: https://koha-community.org/
858 The API supports two sets of endpoints, one targetted at library staff and the other at at library users.
860 Those endpoints under the `/public` path are aimed at delivering functionality tailored to library users and offer
861 a more restricted set of functions, overrides and data in thier responses for data privacy and library policy
862 reasons. Many of these endpoints do not require authentication for fetching public data, though an authenticated
863 session will expose additional options and allow users to see more data where it is part of their own record.
865 All other endpoints are targetted at the staff interface level and allow for additional functionality and a more
866 unrestricted view of data. These endpoints, however, have a level of redaction built in for resources that the
867 api consumer should not have access to. For example, user data for users who do not belong to the same library
868 or library group of your api user will be reduced to just minimum neccesary for a valid response. Object keys will
869 be consistent for all responses, but their values may be removed depending on access.
873 The API supports the following authentication mechanisms
875 * HTTP Basic authentication
876 * OAuth2 (client credentials grant)
879 Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled
880 by system preferences.
884 The API uses existing user profiles to restrict access to resources based on user permissions and the library the
885 API user is assigned to. This may result, at times, in resources being returned in a redacted form with all keys
886 present but sensative values nulled.
888 We do not yet support OAuth Scopes or the Authorization Code grant flow.
892 The API uses standard HTTP status codes to indicate the success or failure
893 of the API call. The body of the response will be JSON in the following format:
897 "error": "Current settings prevent the passed due date to be applied",
898 "error_code": "invalid_due_date"
902 Note: Some routes might offer additional attributes in their error responses but that"s
903 subject to change and thus not documented.
905 ## Filtering responses
907 The API allows for some advanced response filtering using a JSON based query syntax. The
908 query can be added to the requests:
910 * as a query parameter `q=`
911 * in the request body
913 For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname
914 matches one of the fields as described in the particular endpoints response object.
916 We can refine that with more complex matching clauses by nesting a the clause into the
917 object; `{ "fieldname": { "clause": "value" } }`.
919 Available matching clauses include `>`, `<`, `>=`, `<=`, `-like`, and `-not_like`.
921 We can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH`
922 level will result in an "AND" query, whilst combinding them in an `ARRAY` will result in an
923 "OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those
924 results with both field1 containing value2 AND field2 containing value2 for example.
926 Additionally, if you are requesting related data be embedded into the response one can query
927 on the related data using dot notation in the field names.
931 The following request would return any patron with firstname "Henry" and lastname "Acevedo";
933 `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": "Acevedo", "firstname": "Henry" }'`
935 The following request would return any patron whose lastname begins with "Ace";
937 `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": { "-like": "Ace%" }'`
939 The following request would return any patron whose lastname is "Acevedo" OR "Bernardo"
941 `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": [ "Acevedo", "Bernardo" ] }'`
943 The following request embeds the related patron extended attributes data and filters on it.
945 `curl -u koha:koha =--request GET 'http://127.0.0.1:8081/api/v1/patrons/' --header 'x-koha-embed: extended_attributes' --data-raw '{ "extended_attributes.code": "internet", "extended_attributes.attribute": "1" }'`
951 This optional header allows the api consumer to request additional related data
952 to be returned in the api response. It also allows for cross referencing in the
953 queries as described above. It accepts a comma delimited list of relation names.
955 Relations may on occasion also support dot delimited nesting to allow traversal.
959 This optional header should be passed to give your api request a library
960 context; If it is not included in the request, then the request context
961 will default to using your api comsumer"s assigned home library.
963 - description: "Manage article requests\n"
964 name: article_requests
965 x-displayName: Article requests
966 - description: "Manage authorised value categories\n"
967 name: authorised_value_categories
968 x-displayName: Authorised value categories
969 - description: "Manage authorised values\n"
970 name: authorised_values
971 x-displayName: Authorised values
972 - description: "Manage batch import profiles\n"
973 name: batch_import_profiles
974 x-displayName: Batch import profiles
975 - description: "Manage baskets for the acquisitions module\n"
977 x-displayName: Baskets
978 - description: "Manage Authority records\n"
980 x-displayName: Authorities
981 - description: "Manage bibliographic records\n"
983 x-displayName: Biblios
984 - description: "Manage cash register cashups\n"
986 x-displayName: Cashups
987 - description: "Manage checkouts\n"
989 x-displayName: Checkouts
990 - description: "Manage circulation rules\n"
991 name: circulation_rules
992 x-displayName: Circulation rules
993 - description: "Manage cities\n"
995 x-displayName: Cities
996 - description: "Manage patron clubs\n"
999 - description: "Manage ERM agreements\n"
1000 name: erm_agreements
1001 x-displayName: ERM agreements
1002 - description: "Manage ERM configuration\n"
1004 x-displayName: ERM configuration
1005 - description: "Manage ERM docuemnts\n"
1007 x-displayName: ERM documents
1008 - description: "Manage ERM eHoldings packages\n"
1009 name: erm_eholdings_packages
1010 x-displayName: ERM eHoldings packages
1011 - description: "Manage ERM eHoldings resources\n"
1012 name: erm_eholdings_resources
1013 x-displayName: ERM eHoldings resources
1014 - description: "Manage ERM eHoldings titles\n"
1015 name: erm_eholdings_titles
1016 x-displayName: ERM eHoldings titles
1017 - description: "Manage ERM licences\n"
1019 x-displayName: ERM licences
1020 - description: "Manage ERM users\n"
1022 x-displayName: ERM users
1023 - description: "Manage funds for the acquisitions module\n"
1025 x-displayName: Funds
1026 - description: "Manage holds\n"
1028 x-displayName: Holds
1029 - description: "Manage identity providers\n"
1030 name: identity_providers
1031 x-displayName: Identity providers
1032 - description: "Manage ILL module backends\n"
1034 x-displayName: ILL backends
1035 - description: "Manage ILL module batches\n"
1037 x-displayName: ILL batches
1038 - description: "Manage ILL module batch statuses\n"
1039 name: ill_batchstatuses
1040 x-displayName: ILL batch statuses
1041 - description: "Manage ILL requests\n"
1043 x-displayName: ILL requests
1044 - description: "Manage import batches\n"
1045 name: import_batches
1046 x-displayName: Import batches
1047 - description: "Manage item groups\n"
1049 x-displayName: Item groups
1050 - description: "Manage items\n"
1052 x-displayName: Items
1053 - description: "Manage jobs\n"
1056 - description: "Manage libraries\n"
1058 x-displayName: Libraries
1059 - description: "Manage macros\n"
1061 x-displayName: Macros
1062 - description: "Manage acquisition orders\n"
1064 x-displayName: Orders
1065 - description: "Handle OAuth flows\n"
1067 x-displayName: OAuth
1068 - description: "Manage patrons\n"
1070 x-displayName: Patrons
1071 - description: "Manage purchase suggestions\n"
1073 x-displayName: Purchase suggestions
1074 - description: "Manage quotes\n"
1076 x-displayName: Quotes
1077 - description: "Manage return claims\n"
1079 x-displayName: Return claims
1080 - description: "Manage rotas\n"
1082 x-displayName: Rotas
1083 - description: "Manage search filters"
1084 name: search_filters
1085 x-displayName: Search filters
1086 - description: "Manage SMTP servers configurations\n"
1088 x-displayName: SMTP servers
1089 - description: "Manage tickets\n"
1091 x-displayName: Tickets
1092 - description: "Manage transfer limits\n"
1094 x-displayName: Transfer limits
1095 - description: "Handle two factor authentication flows\n"
1097 x-displayName: Two factor authentication
1098 - description: "Manage vendors for the acquisitions module\n"
1100 x-displayName: Vendors