Koha REST API

About

## Background The API supports two sets of endpoints, one targetted at library staff and the other at at library users. Those endpoints under the `/public` path are aimed at delivering functionality tailored to library users and offer a more restricted set of functions, overrides and data in thier responses for data privacy and library policy reasons. Many of these endpoints do not require authentication for fetching public data, though an authenticated session will expose additional options and allow users to see more data where it is part of their own record. All other endpoints are targetted at the staff interface level and allow for additional functionality and a more unrestricted view of data. These endpoints, however, have a level of redaction built in for resources that the api consumer should not have access to. For example, user data for users who do not belong to the same library or library group of your api user will be reduced to just minimum neccesary for a valid response. Object keys will be consistent for all responses, but their values may be removed depending on access. ## Authentication The API supports the following authentication mechanisms * HTTP Basic authentication * OAuth2 (client credentials grant) * Cookie-based Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled by system preferences. ## Authorization The API uses existing user profiles to restrict access to resources based on user permissions and the library the API user is assigned to. This may result, at times, in resources being returned in a redacted form with all keys present but sensative values nulled. We do not yet support OAuth Scopes or the Authorization Code grant flow. ## Errors The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: ``` { "error": "Current settings prevent the passed due date to be applied", "error_code": "invalid_due_date" } ``` Note: Some routes might offer additional attributes in their error responses but that"s subject to change and thus not documented. ## Filtering responses The API allows for some advanced response filtering using a JSON based query syntax. The query can be added to the requests: * as a query parameter `q=` * in the request body For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname matches one of the fields as described in the particular endpoints response object. We can refine that with more complex matching clauses by nesting a the clause into the object; `{ "fieldname": { "clause": "value" } }`. Available matching clauses include `>`, `<`, `>=`, `<=`, `-like`, and `-not_like`. We can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH` level will result in an "AND" query, whilst combinding them in an `ARRAY` will result in an "OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those results with both field1 containing value2 AND field2 containing value2 for example. Additionally, if you are requesting related data be embedded into the response one can query on the related data using dot notation in the field names. ### Examples The following request would return any patron with firstname "Henry" and lastname "Acevedo"; `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": "Acevedo", "firstname": "Henry" }'` The following request would return any patron whose lastname begins with "Ace"; `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": { "-like": "Ace%" }'` The following request would return any patron whose lastname is "Acevedo" OR "Bernardo" `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw '{ "surname": [ "Acevedo", "Bernardo" ] }'` The following request embeds the related patron extended attributes data and filters on it. `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" }'` ## Special headers ### x-koha-embed This optional header allows the api consumer to request additional related data to be returned in the api response. It also allows for cross referencing in the queries as described above. It accepts a comma delimited list of relation names. Relations may on occasion also support dot delimited nesting to allow traversal. ### x-koha-library This optional header should be passed to give your api request a library context; If it is not included in the request, then the request context will default to using your api comsumer"s assigned home library.

Resources

Two factor register

POST /api/v1/auth/two-factor/registration
Operation ID: Two factor register

Generate a secret

Parameters

This resource has no input parameters.

Response 201

{"additionalProperties":false,"properties":{"issuer":{"type":"string"},"key_id":{"type":"string"},"qr_code":{"type":"string"},"secret32":{"type":"string"}},"type":"object"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Two factor register verification

POST /api/v1/auth/two-factor/registration/verification
Operation ID: Two factor register verification

Verify two-factor registration

Parameters

Name	In	Type	Required	Description
secret32	formData	string	Yes	the secret
pin_code	formData	string	Yes	the pin code

Response 204

null

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

addAdvancedEditorMacro

POST /api/v1/advanced_editor/macros
Operation ID: addAdvancedEditorMacro

Add advanced editor macros

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new macro

Body

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 201

Macro added

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addAuthority

POST /api/v1/authorities
Operation ID: addAuthority

Add authority

Add an authority record to Koha. An optional `x-authority-type` may be passed to specify the cataloguing framework to be used (instead of the default). The request body is expected to contain a MARC record in the format specified in the `Content-type` header you pass. Possible values for this header and the corresponding record formats expected are listed below: * application/marcxml+xml: MARCXML * application/marc-in-json: MARC-in-JSON * application/marc: Raw USMARC binary data

Parameters

Name	In	Type	Required	Description
x-authority-type	header	string	No	Authority type code. Use when content type is not application/json
x-koha-override	header	array	No	Overrides list sent as a request header

Response 201

An authority

null

Response 400

Bad request.

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 409

Conflict creating the resource. Possible `error_code` attribute values: * `duplicate`

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addBiblio

POST /api/v1/biblios
Operation ID: addBiblio

Add biblio

Add a bibliographic record to Koha. An optional `x-framework-id` may be passed to specify the cataloguing framework to be used (instead of the default). The request body is expected to contain a MARC record in the format specified in the `Content-type` header you pass. Possible values for this header and the corresponding record formats expected are listed below: * application/marcxml+xml: MARCXML * application/marc-in-json: MARC-in-JSON * application/marc: Raw USMARC binary data

Parameters

Name	In	Type	Required	Description
x-framework-id	header	string	No	Framework id. Use when content type is not application/json
x-record-schema	header	string	No	March schema. One of MARC21 or UNIMARC
x-confirm-not-duplicate	header	integer	No	Confirm the posted element is not a duplicate

Response 200

A biblio

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addBiblioItem

POST /api/v1/biblios/{biblio_id}/items
Operation ID: addBiblioItem

Add an item for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
body	body		Yes	A JSON object containing information about the new item

Body

{"$ref":"#\/definitions\/item_yaml"}

Response 201

Item added

{"$ref":"#\/definitions\/item_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addBooking

POST /api/v1/bookings
Operation ID: addBooking

Add booking

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new booking

Body

{"$ref":"#\/definitions\/booking_yaml"}

Response 201

Booking added

{"$ref":"#\/definitions\/booking_yaml"}

Response 400

Client error

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addCheckout

POST /api/v1/checkouts
Operation ID: addCheckout

Add a new checkout

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new checkout
confirmation	query	string	No	A JWT confirmation token

Body

{"$ref":"#\/definitions\/checkout_yaml"}

Response 201

Created checkout

{"$ref":"#\/definitions\/checkout_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Cannot create checkout

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating checkout

{"$ref":"#\/definitions\/error_yaml"}

Response 412

Precondition failed

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addCheckoutPublic

POST /api/v1/public/patrons/{patron_id}/checkouts
Operation ID: addCheckoutPublic

Add a new checkout (public)

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body		Yes	A JSON object containing information about the new checkout
confirmation	query	string	No	A JWT confirmation token

Body

{"$ref":"#\/definitions\/checkout_yaml"}

Response 201

Created checkout

{"$ref":"#\/definitions\/checkout_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Cannot create checkout

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 405

Method not allowed. Possible `error_code` attribute values: * `FEATURE_DISABLED`

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating checkout. Possible `error_code` attribute values: * `ITEM_NOT_FOUND` * `PATRON_NOT_FOUND`

{"$ref":"#\/definitions\/error_yaml"}

Response 412

Precondition failed

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addCity

POST /api/v1/cities
Operation ID: addCity

Add city

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new hold

Body

{"$ref":"#\/definitions\/city_yaml"}

Response 201

City added

{"$ref":"#\/definitions\/city_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addClubHold

POST /api/v1/clubs/{club_id}/holds
Operation ID: addClubHold

Add a club hold

Parameters

Name	In	Type	Required	Description
club_id	path	integer	Yes	Internal club identifier
body	body	object	Yes	A JSON object containing informations about the new hold

Body

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":["integer","null"]},"default_patron_home":{"description":"For each patron, set pickup location to patron's home library if possible","type":"integer"},"expiration_date":{"description":"Hold end date","format":"date","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_type":{"description":"Limit hold on one itemtype (ignored for item-level holds)","type":["string","null"]},"notes":{"description":"Notes related to this hold","type":["string","null"]},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"}},"required":["pickup_library_id"],"type":"object"}

Response 201

Created club hold

{"$ref":"#\/definitions\/club_hold_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Club not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addERMLicenses

POST /api/v1/erm/licenses
Operation ID: addERMLicenses

Add license

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new agreement's license

Body

{"$ref":"#\/definitions\/erm_license_yaml"}

Response 201

A successfully created license

{"items":{"$ref":"#\/definitions\/erm_license_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addErmAgreements

POST /api/v1/erm/agreements
Operation ID: addErmAgreements

Add agreement

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new agreement

Body

{"$ref":"#\/definitions\/erm_agreement_yaml"}

Response 201

A successfully created agreement

{"items":{"$ref":"#\/definitions\/erm_agreement_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addErmDefaultUsageReports

POST /api/v1/erm/default_usage_reports
Operation ID: addErmDefaultUsageReports

Add default_usage_report

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new default_usage_report

Body

{"$ref":"#\/definitions\/erm_default_usage_report_yaml"}

Response 201

A successfully created default_usage_report

{"items":{"$ref":"#\/definitions\/erm_default_usage_report_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addErmEHoldingsPackages

POST /api/v1/erm/eholdings/{provider}/packages
Operation ID: addErmEHoldingsPackages

Add package

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
body	body		Yes	A JSON object containing information about the new package

Body

{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}

Response 201

A successfully created package

{"items":{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addErmEHoldingsTitles

POST /api/v1/erm/eholdings/{provider}/titles
Operation ID: addErmEHoldingsTitles

Add eholding

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
body	body		Yes	A JSON object containing information about the new title

Body

{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}

Response 201

A successfully created title

{"items":{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addErmUsageDataProviders

POST /api/v1/erm/usage_data_providers
Operation ID: addErmUsageDataProviders

Add usage_data_provider

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new usage_data_provider

Body

{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}

Response 201

A successfully created usage_data_provider

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addHold

POST /api/v1/holds
Operation ID: addHold

Place hold

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	A JSON object containing informations about the new hold
x-koha-override	header	array	No	Overrides list sent as a request header

Body

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":["integer","null"]},"expiration_date":{"description":"Hold end date","format":"date","type":["string","null"]},"hold_date":{"description":"The date the hold was placed","format":"date","type":["string","null"]},"item_group_id":{"description":"Internal item group identifier","type":["integer","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_type":{"description":"Limit hold on one itemtype (ignored for item-level holds)","type":["string","null"]},"non_priority":{"description":"Set this hold as non priority","type":["boolean","null"]},"notes":{"description":"Notes related to this hold","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"}},"required":["patron_id","pickup_library_id"],"type":"object"}

Response 201

Created hold

{"$ref":"#\/definitions\/hold_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Borrower not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addIdentityProvider

POST /api/v1/auth/identity_providers
Operation ID: addIdentityProvider

Add a new identity provider

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing OAuth provider parameters. The `config` object required attributes depends on the chosen `protocol` ## OAuth Requires: * key * secret * authorize_url * token_url ## OIDC Requires: * key * secret * well_known_url

Body

{"$ref":"#\/definitions\/identity_provider_yaml"}

Response 201

The generated identity provider

{"$ref":"#\/definitions\/identity_provider_yaml"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addIdentityProviderDomain

POST /api/v1/auth/identity_providers/{identity_provider_id}/domains
Operation ID: addIdentityProviderDomain

Add an identity provider domain

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
body	body		Yes	An identity provider domain object

Body

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

Response 201

Updated identity provider domain

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addIllbatch

POST /api/v1/ill/batches
Operation ID: addIllbatch

Add ILL batch

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new batch
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/ill_batch_yaml"}

Response 201

Batch added

{"$ref":"#\/definitions\/ill_batch_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron with given cardnumber not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addIllbatchstatus

POST /api/v1/ill/batchstatuses
Operation ID: addIllbatchstatus

Add ILL batch status

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new batch status

Body

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

Response 201

Batch status added

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addIllrequest

POST /api/v1/ill/requests
Operation ID: addIllrequest

Add ILL request

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new request

Body

{"$ref":"#\/definitions\/ill_request_yaml"}

Response 201

Request added

{"$ref":"#\/definitions\/ill_request_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addImportBatchProfiles

POST /api/v1/import_batch_profiles
Operation ID: addImportBatchProfiles

Add batch import profile

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	A JSON object containing a import batch profile

Body

{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"}

Response 201

Created Profile

{"$ref":"#\/definitions\/import_batch_profile_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Borrower not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addItemGroup

POST /api/v1/biblios/{biblio_id}/item_groups
Operation ID: addItemGroup

Add item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
body	body	object	Yes	A JSON object representing an item group

Body

{"additionalProperties":false,"properties":{"description":{"description":"ItemGroup description","type":"string"},"display_order":{"description":"Position in waiting queue","type":"integer"}},"type":"object"}

Response 201

A successfully created item group

{"$ref":"#\/definitions\/item_group_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addItemGroupItem

POST /api/v1/biblios/{biblio_id}/item_groups/{item_group_id}/items
Operation ID: addItemGroupItem

Add item to item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
item_group_id	path	string	Yes	Internal identifier for the item group
body	body	object	Yes	A JSON object containing an item_id
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"additionalProperties":false,"properties":{"item_id":{"description":"Internal identifier for an item to be linked","type":"integer"}},"type":"object"}

Response 201

Item linked to item group

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Request conflicts

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addItemToTrain

POST /api/v1/preservation/trains/{train_id}/items
Operation ID: addItemToTrain

Add item to train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
body	body		Yes	An item

Body

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 201

A successfully added item

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addItemsToTrain

POST /api/v1/preservation/trains/{train_id}/items/batch
Operation ID: addItemsToTrain

Add items to train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
body	body	array	Yes	A list of items

Body

{"items":{"type":"object"},"type":"array"}

Response 201

A successfully added list of items

{"items":{"type":"object"},"type":"array"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addItemsToWaitingList

POST /api/v1/preservation/waiting-list/items
Operation ID: addItemsToWaitingList

Add items to waiting list

Parameters

Name	In	Type	Required	Description
body	body	array	Yes	A list of itemnumbers or barcodes

Body

{"items":{"type":"object"},"type":"array"}

Response 201

A successfully added list of items

{"items":{"type":"object"},"type":"array"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addLibrary

POST /api/v1/libraries
Operation ID: addLibrary

Add library

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new library

Body

{"$ref":"#\/definitions\/library_yaml"}

Response 201

Library added

{"$ref":"#\/definitions\/library_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addOrder

POST /api/v1/acquisitions/orders
Operation ID: addOrder

Add order

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object representing an order

Body

{"$ref":"#\/definitions\/order_yaml"}

Response 201

Order added

{"$ref":"#\/definitions\/order_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating the resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPatron

POST /api/v1/patrons
Operation ID: addPatron

Add patron

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new patron
x-koha-override	header	array	No	Overrides list sent as a request header

Body

{"$ref":"#\/definitions\/patron_yaml"}

Response 201

A successfully created patron

{"items":{"$ref":"#\/definitions\/patron_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPatronAttribute

POST /api/v1/patrons/{patron_id}/extended_attributes
Operation ID: addPatronAttribute

Add extended attribute for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body		Yes	A JSON representation of the patron extended attribute

Body

{"$ref":"#\/definitions\/patron_extended_attribute_yaml"}

Response 201

A successfully created patron extended attribute

{"$ref":"#\/definitions\/patron_extended_attribute_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPatronCredit

POST /api/v1/patrons/{patron_id}/account/credits
Operation ID: addPatronCredit

Add credit to a patron's account

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body		Yes	A JSON object containing credit information

Body

{"$ref":"#\/definitions\/patron_account_credit_yaml"}

Response 201

Credit added

{"$ref":"#\/definitions\/account_line_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPatronDebit

POST /api/v1/patrons/{patron_id}/account/debits
Operation ID: addPatronDebit

Add debit to a patron's account

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body		Yes	A JSON object containing debit information

Body

{"$ref":"#\/definitions\/debit_yaml"}

Response 201

Debit added

{"$ref":"#\/definitions\/debit_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPreservationProcessings

POST /api/v1/preservation/processings
Operation ID: addPreservationProcessings

Add processing

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new processing

Body

{"$ref":"#\/definitions\/preservation_processing_yaml"}

Response 201

A successfully created processing

{"items":{"$ref":"#\/definitions\/preservation_processing_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addPreservationTrains

POST /api/v1/preservation/trains
Operation ID: addPreservationTrains

Add train

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about the new train

Body

{"$ref":"#\/definitions\/preservation_train_yaml"}

Response 201

A successfully created train

{"items":{"$ref":"#\/definitions\/preservation_train_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addQuote

POST /api/v1/quotes
Operation ID: addQuote

Add quote

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new quote

Body

{"$ref":"#\/definitions\/quote_yaml"}

Response 201

Quote added

{"$ref":"#\/definitions\/quote_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addSMTPServer

POST /api/v1/config/smtp_servers
Operation ID: addSMTPServer

Add SMTP server

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object representing a new SMTP server configuration

Body

{"$ref":"#\/definitions\/smtp_server_yaml"}

Response 201

An SMTP server object

{"$ref":"#\/definitions\/smtp_server_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addSearchFilter

POST /api/v1/search_filters
Operation ID: addSearchFilter

Add search filter

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new search filter

Body

{"$ref":"#\/definitions\/search_filter_yaml"}

Response 201

Search filter added

{"$ref":"#\/definitions\/search_filter_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating the resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addSuggestions

POST /api/v1/suggestions
Operation ID: addSuggestions

Add a purchase suggestion

This resource accepts a new purchase suggestion and creates it

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new suggestion
x-koha-override	header	array	No	Overrides list sent as a request header

Body

{"$ref":"#\/definitions\/suggestion_yaml"}

Response 201

Suggestion added

{"$ref":"#\/definitions\/suggestion_yaml"}

Response 400

Bad request. Possible `error_code` attribute values: * `max_total_reached` * `max_pending_reached`

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addTicket

POST /api/v1/tickets
Operation ID: addTicket

Add ticket

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new ticket

Body

{"$ref":"#\/definitions\/ticket_yaml"}

Response 201

Ticket added

{"$ref":"#\/definitions\/ticket_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addTicketPublic

POST /api/v1/public/tickets
Operation ID: addTicketPublic

Add ticket

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new ticket

Body

{"$ref":"#\/definitions\/ticket_yaml"}

Response 201

Ticket added

{"$ref":"#\/definitions\/ticket_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addTicketUpdate

POST /api/v1/tickets/{ticket_id}/updates
Operation ID: addTicketUpdate

Add an update to the ticket

Parameters

Name	In	Type	Required	Description
ticket_id	path	integer	Yes	Internal ticket identifier
body	body		Yes	A ticket update object

Body

{"$ref":"#\/definitions\/ticket_update_yaml"}

Response 201

Ticket added

{"$ref":"#\/definitions\/ticket_update_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ticket not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addToBundle

POST /api/v1/items/{item_id}/bundled_items
Operation ID: addToBundle

Add item to bundle

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
body	body		Yes	A JSON object containing information about the new bundle link

Body

{"$ref":"#\/definitions\/bundle_link_yaml"}

Response 201

A successfully created bundle link

{"items":{"$ref":"#\/definitions\/item_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addTransferLimit

POST /api/v1/transfer_limits
Operation ID: addTransferLimit

Add a transfer limit

This resource accepts a new transfer limit and creates it if it does not already exist.

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing information about a new transfer limit

Body

{"$ref":"#\/definitions\/transfer_limit_yaml"}

Response 201

Transfer limit added

{"$ref":"#\/definitions\/transfer_limit_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addVendor

POST /api/v1/acquisitions/vendors
Operation ID: addVendor

Add vendor

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object representing a vendor

Body

{"$ref":"#\/definitions\/vendor_yaml"}

Response 201

Vendor added

{"$ref":"#\/definitions\/vendor_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Vendor not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

addsharedAdvancedEditorMacro

POST /api/v1/advanced_editor/macros/shared
Operation ID: addsharedAdvancedEditorMacro

Add shared advanced editor macros

Parameters

Name	In	Type	Required	Description
body	body		Yes	A JSON object containing informations about the new macro

Body

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 201

Macro added

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

allows_renewalCheckout

GET /api/v1/checkouts/{checkout_id}/allows_renewal
Operation ID: allows_renewalCheckout

Get renewability for a checkout

Parameters

Name	In	Type	Required	Description
checkout_id	path	integer	Yes	Internal checkout identifier

Response 200

Checkout renewability information

{"$ref":"#\/definitions\/allows_renewal_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

availabilityCheckouts

GET /api/v1/checkouts/availability
Operation ID: availabilityCheckouts

Get checkout availability

Parameters

Name	In	Type	Required	Description
patron_id	query	integer	No	Internal patron identifier
item_id	query	integer	No	Internal item identifier

Response 200

Availability

{"$ref":"#\/definitions\/checkout_availability_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

availabilityCheckoutsPublic

GET /api/v1/public/checkouts/availability
Operation ID: availabilityCheckoutsPublic

Get checkout availability

Parameters

Name	In	Type	Required	Description
patron_id	query	integer	No	Internal patron identifier
item_id	query	integer	No	Internal item identifier

Response 200

Availability

{"additionalProperties":false,"properties":{"blockers":{"type":"object"},"confirmation_token":{"type":"string"},"confirms":{"type":"object"},"warnings":{"type":"object"}},"type":"object"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

batchAddTransferLimits

POST /api/v1/transfer_limits/batch
Operation ID: batchAddTransferLimits

Batch add transfer limits

This resource batch creates new transfer limits based on the given data. Transfer limits can be defined based on `collection_code` or `item_type`. The endpoint only accepts one at a time, and which one is used will depend on the value of the `BranchTransferLimitsType` system preference. For example, if the paramters `to_library_id: 'BranchA'` and `item_type: 'BOOK'` are passed in new transfer limits for `BOOK`s will be created, with one transfer limit each for all the branches defined in Koha. Given 4 branches, 3 limits would be created: * to_library_id: 'BranchA', from_library_id: 'BranchB', item_type: 'BOOK' * to_library_id: 'BranchA', from_library_id: 'BranchC', item_type: 'BOOK' * to_library_id: 'BranchA', from_library_id: 'BranchD', item_type: 'BOOK' The body of the query would look like ``` { 'to_library_id': 'BranchA', 'item_type': 'BOOK' } ``` As another example, imagine we have an itemtype that is never supposed to be transferred to another library. If we call that itemtype `LOCAL_ONLY` we would need to just pass `item_type: 'LOCAL_ONLY'`, which would create transfer limits for all libraries, meaning those items would never be allowed to transfer to another library. The body of the query would look like ``` { 'item_type': 'LOCAL_ONLY' } ```

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	A JSON object containing information about new transfer limits.

Body

{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"type":"object"}

Response 201

A list of transfer limits

{"items":{"$ref":"#\/definitions\/transfer_limit_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

batchDeleteTransferLimits

DELETE /api/v1/transfer_limits/batch
Operation ID: batchDeleteTransferLimits

Batch delete transfer limits

This endpoint works just like [the POST version](#op-post-transfer_limits-batch), except it deletes transfer in batch rather than creating them.

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	A JSON object containing information about new transfer limits.

Body

{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"type":"object"}

Response 204

Transfer limits deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

bundledItems

GET /api/v1/items/{item_id}/bundled_items
Operation ID: bundledItems

List bundled items

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
external_id	query	string	No	Search on the item's barcode
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of item

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

cancelArticleRequest

DELETE /api/v1/article_requests/{article_request_id}
Operation ID: cancelArticleRequest

Cancel article requests

Parameters

Name	In	Type	Required	Description
article_request_id	path	integer	Yes	Article request identifier
cancellation_reason	query	string	No	Article request cancellation reason
notes	query	string	No	Article request custom cancellation reason

Response 204

Article request canceled

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

cancelPatronHoldPublic

DELETE /api/v1/public/patrons/{patron_id}/holds/{hold_id}
Operation ID: cancelPatronHoldPublic

Cancel a patron's hold (public)

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
hold_id	path	integer	Yes	Internal hold identifier

Response 202

Hold cancellation request accepted

null

Response 204

Hold cancelled

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

claimReturned

POST /api/v1/return_claims
Operation ID: claimReturned

Add a return claim

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"charge_lost_fee":{"description":"Charge a lost fee if true and Koha is set to allow a choice. Ignored otherwise.","type":"boolean"},"created_by":{"description":"User id for the librarian submitting this claim","type":"string"},"item_id":{"description":"Internal item id to claim as returned","type":"integer"},"notes":{"description":"Notes about this return claim","type":"string"}},"type":"object"}

Response 201

Created claim

{"$ref":"#\/definitions\/return_claim_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict creating the resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

copyItemToAnotherTrain

POST /api/v1/preservation/trains/{train_id}/items/{train_item_id}/copy
Operation ID: copyItemToAnotherTrain

Copy an item to an other train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
train_item_id	path	integer	Yes	train item internal identifier
body	body	object	Yes	The train_id of the new train

Body

{"additionalProperties":false,"properties":{"train_id":{"description":"Train id","type":"integer"}},"type":"object"}

Response 201

A successfully copied item

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

delIdentityProvider

DELETE /api/v1/auth/identity_providers/{identity_provider_id}
Operation ID: delIdentityProvider

Delete identity provider

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier

Response 204

identity provider deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

City not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

null

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

delIdentityProviderDomain

DELETE /api/v1/auth/identity_providers/{identity_provider_id}/domains/{identity_provider_domain_id}
Operation ID: delIdentityProviderDomain

Delete identity provider

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
identity_provider_domain_id	path	integer	Yes	Identity provider domain internal identifier

Response 204

identity provider deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

City not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

null

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteAdvancedEditorMacro

DELETE /api/v1/advanced_editor/macros/{advancededitormacro_id}
Operation ID: deleteAdvancedEditorMacro

Delete advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier

Response 204

Advanced editor macro deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Macro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteAuthority

DELETE /api/v1/authorities/{authority_id}
Operation ID: deleteAuthority

Delete authority

Parameters

Name	In	Type	Required	Description
authority_id	path	integer	Yes	Authority identifier

Response 204

Authority deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Authority not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteBatch

DELETE /api/v1/ill/batches/{ill_batch_id}
Operation ID: deleteBatch

Delete ILL batch

Parameters

Name	In	Type	Required	Description
ill_batch_id	path	integer	Yes	Internal ILL batch identifier

Response 204

ILL batch deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteBatchstatus

DELETE /api/v1/ill/batchstatuses/{ill_batchstatus_code}
Operation ID: deleteBatchstatus

Delete ILL batch status

Parameters

Name	In	Type	Required	Description
ill_batchstatus_code	path	string	Yes	Internal ILL batch status identifier

Response 204

ILL batch status deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch status not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteBiblio

DELETE /api/v1/biblios/{biblio_id}
Operation ID: deleteBiblio

Delete biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier

Response 204

Biblio deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Unable to perform action on biblio

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteBooking

DELETE /api/v1/bookings/{booking_id}
Operation ID: deleteBooking

Delete booking

Parameters

Name	In	Type	Required	Description
booking_id	path	integer	Yes	Booking identifier

Response 204

Booking deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Booking not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteCity

DELETE /api/v1/cities/{city_id}
Operation ID: deleteCity

Delete city

Parameters

Name	In	Type	Required	Description
city_id	path	integer	Yes	City internal identifier

Response 204

City deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

City not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteERMCounterFiles

DELETE /api/v1/erm/counter_files/{erm_counter_files_id}
Operation ID: deleteERMCounterFiles

Delete counter_file

Parameters

Name	In	Type	Required	Description
erm_counter_files_id	path	integer	Yes	ERM counter_files internal identifier

Response 204

counter_file deleted

null

Response 400

counter_file deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteERMDefaultUsageReports

DELETE /api/v1/erm/default_usage_reports/{erm_default_usage_report_id}
Operation ID: deleteERMDefaultUsageReports

Delete default_usage_report

Parameters

Name	In	Type	Required	Description
erm_default_usage_report_id	path	integer	Yes	ERM default_usage_report internal identifier

Response 204

default_usage_report deleted

null

Response 400

default_usage_report deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteERMUsageDataProviders

DELETE /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}
Operation ID: deleteERMUsageDataProviders

Delete usage_data_provider

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier

Response 204

usage_data_provider deleted

null

Response 400

usage_data_provider deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteERMlicenses

DELETE /api/v1/erm/licenses/{license_id}
Operation ID: deleteERMlicenses

Delete license

Parameters

Name	In	Type	Required	Description
license_id	path	integer	Yes	License internal identifier

Response 204

license deleted

null

Response 400

license deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteErmAgreements

DELETE /api/v1/erm/agreements/{agreement_id}
Operation ID: deleteErmAgreements

Delete agreement

Parameters

Name	In	Type	Required	Description
agreement_id	path	integer	Yes	Agreement internal identifier

Response 204

Agreement deleted

null

Response 400

Agreement deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteErmEHoldingsPackages

DELETE /api/v1/erm/eholdings/{provider}/packages/{package_id}
Operation ID: deleteErmEHoldingsPackages

Delete eHoldings package

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
package_id	path	string	Yes	Package internal identifier

Response 204

package deleted

null

Response 400

package deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteErmEHoldingsTitles

DELETE /api/v1/erm/eholdings/{provider}/titles/{title_id}
Operation ID: deleteErmEHoldingsTitles

Delete eHolding title

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
title_id	path	integer	Yes	Title internal identifier

Response 204

title deleted

null

Response 400

title deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteHold

DELETE /api/v1/holds/{hold_id}
Operation ID: deleteHold

Cancel hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
x-koha-override	header	array	No	Overrides list sent as a request header

Response 202

Hold request recorded

null

Response 204

Hold deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteImportBatchProfiles

DELETE /api/v1/import_batch_profiles/{import_batch_profile_id}
Operation ID: deleteImportBatchProfiles

Delete batch import profile

Parameters

Name	In	Type	Required	Description
import_batch_profile_id	path	integer	Yes	Internal profile identifier

Response 204

Profile deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteItem

DELETE /api/v1/items/{item_id}
Operation ID: deleteItem

Delete item

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier

Response 204

Deleted item

null

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Item not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict. Possible `error_code` attribute values: * book_on_loan: The item is checked out * book_reserved: Waiting or in-transit hold for the item * last_item_for_hold: The item is the last one on a record on which a biblio-level hold is placed * linked_analytics: The item has linked analytic records * not_same_branch: The item is blocked by independent branches

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteItemGroup

DELETE /api/v1/biblios/{biblio_id}/item_groups/{item_group_id}
Operation ID: deleteItemGroup

Delete item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
item_group_id	path	string	Yes	Internal identifier for the item group

Response 204

ItemGroup deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ItemGroup not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteItemGroupItems

DELETE /api/v1/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}
Operation ID: deleteItemGroupItems

Delete item from item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
item_group_id	path	string	Yes	Internal identifier for the item group
item_id	path	string	Yes	Internal identifier for the item

Response 204

Item unlinked from item group

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Item not linked to item group

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteLibrary

DELETE /api/v1/libraries/{library_id}
Operation ID: deleteLibrary

Delete library

Parameters

Name	In	Type	Required	Description
library_id	path	string	Yes	Internal library identifier

Response 204

Library deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteOrder

DELETE /api/v1/acquisitions/orders/{order_id}
Operation ID: deleteOrder

Delete order

Parameters

Name	In	Type	Required	Description
order_id	path	integer	Yes	Internal order identifier

Response 204

Order deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Order not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletePatron

DELETE /api/v1/patrons/{patron_id}
Operation ID: deletePatron

Delete patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier

Response 204

Patron deleted

null

Response 400

Patron deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict. Possible `error_code` attribute values: * `has_checkouts`: The patron has pending checkouts * `has_debt`: The patron has pending debts * `has_guarantees`: The patron has guarantees * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted * `is_protected`: Protected patrons cannot be deleted

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletePatronAttribute

DELETE /api/v1/patrons/{patron_id}/extended_attributes/{extended_attribute_id}
Operation ID: deletePatronAttribute

Delete extended attribute

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
extended_attribute_id	path	integer	Yes	Internal patron extended attribute identifier

Response 204

Extended patron attribute deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletePreservationProcessings

DELETE /api/v1/preservation/processings/{processing_id}
Operation ID: deletePreservationProcessings

Delete processing

Parameters

Name	In	Type	Required	Description
processing_id	path	integer	Yes	processing internal identifier

Response 204

processing deleted

null

Response 400

processing deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletePreservationTrains

DELETE /api/v1/preservation/trains/{train_id}
Operation ID: deletePreservationTrains

Delete train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier

Response 204

Train deleted

null

Response 400

Train deletion failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in deleting resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteQuote

DELETE /api/v1/quotes/{quote_id}
Operation ID: deleteQuote

Delete quote

Parameters

Name	In	Type	Required	Description
quote_id	path	integer	Yes	Quote internal identifier

Response 204

Quote deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Quote not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteSMTPServer

DELETE /api/v1/config/smtp_servers/{smtp_server_id}
Operation ID: deleteSMTPServer

Delete SMTP server

Parameters

Name	In	Type	Required	Description
smtp_server_id	path	integer	Yes	SMTP server internal identifier

Response 204

SMTP server deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

DELETE /api/v1/search_filters/{search_filter_id}
Operation ID: deleteSearchFilter

Delete search filter

Parameters

Name	In	Type	Required	Description
search_filter_id	path	integer	Yes	Search filter internal identifier

Response 204

Searc filter deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Search filter not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteSuggestion

DELETE /api/v1/suggestions/{suggestion_id}
Operation ID: deleteSuggestion

Delete purchase suggestion

This resource deletes an existing purchase suggestion

Parameters

Name	In	Type	Required	Description
suggestion_id	path	integer	Yes	Internal suggestion identifier

Response 204

Suggestion deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Suggestion not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteTicket

DELETE /api/v1/tickets/{ticket_id}
Operation ID: deleteTicket

Delete ticket

Parameters

Name	In	Type	Required	Description
ticket_id	path	integer	Yes	Internal ticket identifier

Response 204

Ticket deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ticket not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteTransferLimit

DELETE /api/v1/transfer_limits/{limit_id}
Operation ID: deleteTransferLimit

Delete transfer limit

This resource deletes a transfer limit for the given limit id

Parameters

Name	In	Type	Required	Description
limit_id	path	string	Yes	Internal transfer limit identifier

Response 204

Transfer limit deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deleteVendor

DELETE /api/v1/acquisitions/vendors/{vendor_id}
Operation ID: deleteVendor

Delete vendor

Parameters

Name	In	Type	Required	Description
vendor_id	path	integer	Yes	Vendor id

Response 204

Vendor deleted

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Vendor not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletedClaim

DELETE /api/v1/return_claims/{claim_id}
Operation ID: deletedClaim

Delete claim

Parameters

Name	In	Type	Required	Description
claim_id	path	integer	Yes	Unique identifier for the claim to be deleted

Response 204

Claim deleted

{"$ref":"#\/definitions\/return_claim_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Claim not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

deletesharedAdvancedEditorMacro

DELETE /api/v1/advanced_editor/macros/shared/{advancededitormacro_id}
Operation ID: deletesharedAdvancedEditorMacro

Delete shared advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier

Response 204

Advanced editor macro deleted

{"type":"string"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Macro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

downloadCounterFile

GET /api/v1/erm/counter_files/{erm_counter_files_id}/file/content
Operation ID: downloadCounterFile

Download Counter file

Parameters

Name	In	Type	Required	Description
erm_counter_files_id	path	integer	Yes	Case insensitive search on erm_counter_files_id

Response 200

A counter file

{"type":"file"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

downloadErmDocument

GET /api/v1/erm/documents/{document_id}/file/content
Operation ID: downloadErmDocument

Download erm document

Parameters

Name	In	Type	Required	Description
document_id	path	integer	Yes	Case insensitive search on document_id

Response 200

Anagreement

{"type":"file"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

editErmEHoldingsPackages

PATCH /api/v1/erm/eholdings/{provider}/packages/{package_id}
Operation ID: editErmEHoldingsPackages

Edit a package

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
body	body	object	Yes	A JSON object containing the fields to edit
package_id	path	string	Yes	Package internal identifier

Body

{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this package from remote holdings","type":"boolean"}},"type":"object"}

Response 200

What has been modified

{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this package from remote holdings","type":"boolean"}},"type":"object"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Package not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

editErmEHoldingsResources

PATCH /api/v1/erm/eholdings/{provider}/resources/{resource_id}
Operation ID: editErmEHoldingsResources

Edit a resource

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
body	body	object	Yes	A JSON object containing the fields to edit
resource_id	path	string	Yes	Resource internal identifier

Body

{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this resource from remote holdings","type":"boolean"}},"type":"object"}

Response 200

What has been modified

{"additionalProperties":false,"properties":{"is_selected":{"description":"Add or remove this resource from remote holdings","type":"boolean"}},"type":"object"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

editHold

PATCH /api/v1/holds/{hold_id}
Operation ID: editHold

Update hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"},"priority":{"description":"Position in waiting queue","minimum":1,"type":"integer"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":"string"}},"type":"object"}

Response 200

Updated hold

{"$ref":"#\/definitions\/hold_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

editImportBatchProfiles

PUT /api/v1/import_batch_profiles/{import_batch_profile_id}
Operation ID: editImportBatchProfiles

Update batch import profile

Parameters

Name	In	Type	Required	Description
import_batch_profile_id	path	integer	Yes	Internal profile identifier
body	body	object	Yes	A JSON object containing a import batch profile

Body

{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"}

Response 200

Updated profile

{"$ref":"#\/definitions\/import_batch_profile_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Borrower not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getAdvancedEditorMacro

GET /api/v1/advanced_editor/macros/{advancededitormacro_id}
Operation ID: getAdvancedEditorMacro

Get advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier

Response 200

A macro

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

AdvancedEditorMacro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getAuthority

GET /api/v1/authorities/{authority_id}
Operation ID: getAuthority

Get authority

Parameters

Name	In	Type	Required	Description
authority_id	path	integer	Yes	Authority identifier

Response 200

An authority

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Authority not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblio

GET /api/v1/biblios/{biblio_id}
Operation ID: getBiblio

Get biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier

Response 200

A biblio

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblioBookings

GET /api/v1/biblios/{biblio_id}/bookings
Operation ID: getBiblioBookings

Get bookings for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of the bookings attached to the record

{"items":{"$ref":"#\/definitions\/booking_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblioItems

GET /api/v1/biblios/{biblio_id}/items
Operation ID: getBiblioItems

Get items for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
bookable	query	boolean	No	Limit to items that are bookable

Body

{"type":"object"}

Response 200

A list of the items attached to the record

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblioItemsPublic

GET /api/v1/public/biblios/{biblio_id}/items
Operation ID: getBiblioItemsPublic

This resource is not documented.

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of the items attached to the record

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblioPickupLocations

GET /api/v1/biblios/{biblio_id}/pickup_locations
Operation ID: getBiblioPickupLocations

Get valid pickup locations for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
patron_id	query	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

Biblio pickup locations

{"items":{"$ref":"#\/definitions\/library_yaml"},"type":"array"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBiblioPublic

GET /api/v1/public/biblios/{biblio_id}
Operation ID: getBiblioPublic

Get biblio (public)

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier

Response 200

A biblio

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getBooking

GET /api/v1/bookings/{booking_id}
Operation ID: getBooking

Get booking

Parameters

Name	In	Type	Required	Description
booking_id	path	integer	Yes	Booking identifier

Response 200

A booking

{"$ref":"#\/definitions\/booking_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Booking not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getCashup

GET /api/v1/cashups/{cashup_id}
Operation ID: getCashup

Get cashup

Parameters

Name	In	Type	Required	Description
cashup_id	path	integer	Yes	Cashup internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A cashup

{"$ref":"#\/definitions\/cashup_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getCheckout

GET /api/v1/checkouts/{checkout_id}
Operation ID: getCheckout

Get checkout

Parameters

Name	In	Type	Required	Description
checkout_id	path	integer	Yes	Internal checkout identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

Updated borrower's checkout

{"$ref":"#\/definitions\/checkout_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getCirculationRuleKinds

GET /api/v1/circulation-rules/kinds
Operation ID: getCirculationRuleKinds

Get circulation rules kinds

Parameters

This resource has no input parameters.

Response 200

A map of rule kind information

{"additionalProperties":{"$ref":"#\/definitions\/circ-rule-kind_yaml"},"type":"object"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getCity

GET /api/v1/cities/{city_id}
Operation ID: getCity

Get city

Parameters

Name	In	Type	Required	Description
city_id	path	integer	Yes	City internal identifier

Response 200

A city

{"$ref":"#\/definitions\/city_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

City not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMUsageDataProvider

GET /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}
Operation ID: getERMUsageDataProvider

get usage_data_provider

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

usage_data_provider

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMUsageMetricTypesReport

GET /api/v1/erm/eUsage/metric_types_report/{data_type}
Operation ID: getERMUsageMetricTypesReport

get usage metric_types report

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
data_type	path	string	Yes	ERM custom report data type
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

custom_report

{"items":{"$ref":"#\/definitions\/erm_custom_report_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMUsageMonthlyReport

GET /api/v1/erm/eUsage/monthly_report/{data_type}
Operation ID: getERMUsageMonthlyReport

get usage monthly report

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
data_type	path	string	Yes	ERM custom report data type
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

custom_report

{"items":{"$ref":"#\/definitions\/erm_custom_report_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMUsageProviderRollupReport

GET /api/v1/erm/eUsage/provider_rollup_report/{data_type}
Operation ID: getERMUsageProviderRollupReport

get usage provider rollup report

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
data_type	path	string	Yes	ERM custom report data type
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

custom_report

{"items":{"$ref":"#\/definitions\/erm_custom_report_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMUsageYearlyReport

GET /api/v1/erm/eUsage/yearly_report/{data_type}
Operation ID: getERMUsageYearlyReport

get usage yearly report

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
data_type	path	string	Yes	ERM custom report data type
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

custom_report

{"items":{"$ref":"#\/definitions\/erm_custom_report_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMconfig

GET /api/v1/erm/config
Operation ID: getERMconfig

get the ERM config

This resource returns a list of options needed for the ERM Vue app. EXPERIMENTAL - DO NOT RELY on this, it is subject to change!

Parameters

This resource has no input parameters.

Response 200

The ERM config

{"$ref":"#\/definitions\/erm_config_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getERMlicense

GET /api/v1/erm/licenses/{license_id}
Operation ID: getERMlicense

get license

Parameters

Name	In	Type	Required	Description
license_id	path	integer	Yes	License internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

license

{"items":{"$ref":"#\/definitions\/erm_license_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getErmAgreements

GET /api/v1/erm/agreements/{agreement_id}
Operation ID: getErmAgreements

Get agreement

Parameters

Name	In	Type	Required	Description
agreement_id	path	integer	Yes	Agreement internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An agreement

{"items":{"$ref":"#\/definitions\/erm_agreement_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getErmEHoldingsPackages

GET /api/v1/erm/eholdings/{provider}/packages/{package_id}
Operation ID: getErmEHoldingsPackages

Get eHoldings package

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
package_id	path	string	Yes	Package internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A package

{"items":{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getErmEHoldingsResources

GET /api/v1/erm/eholdings/{provider}/resources/{resource_id}
Operation ID: getErmEHoldingsResources

Get resources

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
resource_id	path	string	Yes	Resource internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An eHolding resource

{"items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getErmEHoldingsTitles

GET /api/v1/erm/eholdings/{provider}/titles/{title_id}
Operation ID: getErmEHoldingsTitles

Get titles

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
title_id	path	integer	Yes	Title internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An eHolding title

{"items":{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getHoldPickupLocations

GET /api/v1/holds/{hold_id}/pickup_locations
Operation ID: getHoldPickupLocations

Get valid pickup locations for hold

Parameters

Name	In	Type	Required	Description
x-koha-override	header	array	No	Overrides list sent as a request header
hold_id	path	integer	Yes	Internal hold identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

Hold pickup location

{"items":{"$ref":"#\/definitions\/library_yaml"},"type":"array"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold pickup location list not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getIdentityProvider

GET /api/v1/auth/identity_providers/{identity_provider_id}
Operation ID: getIdentityProvider

Get identity provider

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An identity provider

{"$ref":"#\/definitions\/identity_provider_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getIdentityProviderDomain

GET /api/v1/auth/identity_providers/{identity_provider_id}/domains/{identity_provider_domain_id}
Operation ID: getIdentityProviderDomain

Get identity provider domain

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
identity_provider_domain_id	path	integer	Yes	Identity provider domain internal identifier

Response 200

An identity provider

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getIllbackends

GET /api/v1/ill/backends/{ill_backend_id}
Operation ID: getIllbackends

Get ILL backend

Parameters

Name	In	Type	Required	Description
ill_backend_id	path	string	Yes	ILL backend id/name
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An ILL backends

{"$ref":"#\/definitions\/ill_backend_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL backends not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getIllbatches

GET /api/v1/ill/batches/{ill_batch_id}
Operation ID: getIllbatches

Get ILL batch

Parameters

Name	In	Type	Required	Description
ill_batch_id	path	string	Yes	ILL batch id/name/contents
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

An ILL batch

{"$ref":"#\/definitions\/ill_batch_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getIllbatchstatuses

GET /api/v1/ill/batchstatuses/{ill_batchstatus_code}
Operation ID: getIllbatchstatuses

Get ILL batch status

Parameters

Name	In	Type	Required	Description
ill_batchstatus_code	path	string	Yes	ILL batch status

Response 200

An ILL batch status

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch status not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getItem

GET /api/v1/items/{item_id}
Operation ID: getItem

Get item

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An item

{"$ref":"#\/definitions\/item_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Item not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getItemBookings

GET /api/v1/items/{item_id}/bookings
Operation ID: getItemBookings

Get existing bookings for an item

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

Item bookings

{"items":{"$ref":"#\/definitions\/booking_yaml"},"type":"array"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Item not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getItemFromPreservationTrains

GET /api/v1/preservation/trains/{train_id}/items/{train_item_id}
Operation ID: getItemFromPreservationTrains

Get item from train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
train_item_id	path	integer	Yes	train item internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An item in train

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getItemGroup

GET /api/v1/biblios/{biblio_id}/item_groups/{item_group_id}
Operation ID: getItemGroup

Get item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
item_group_id	path	string	Yes	Internal identifier for the item_group
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An item group

{"$ref":"#\/definitions\/item_group_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

ItemGroup not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getItemPickupLocations

GET /api/v1/items/{item_id}/pickup_locations
Operation ID: getItemPickupLocations

Get valid pickup locations for an item

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
patron_id	query	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

Item pickup locations

{"items":{"$ref":"#\/definitions\/library_yaml"},"type":"array"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getJob

GET /api/v1/jobs/{job_id}
Operation ID: getJob

Get a job

Parameters

Name	In	Type	Required	Description
job_id	path	integer	Yes	Job internal identifier

Response 200

A job

{"$ref":"#\/definitions\/job_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Job not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getLibrary

GET /api/v1/libraries/{library_id}
Operation ID: getLibrary

Get library

Parameters

Name	In	Type	Required	Description
library_id	path	string	Yes	Internal library identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A library

{"$ref":"#\/definitions\/library_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

getLibraryPublic

GET /api/v1/public/libraries/{library_id}
Operation ID: getLibraryPublic

Get library (public)

Parameters

Name	In	Type	Required	Description
library_id	path	string	Yes	Internal library identifier

Response 200

A library

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getOrder

GET /api/v1/acquisitions/orders/{order_id}
Operation ID: getOrder

Get order

Parameters

Name	In	Type	Required	Description
order_id	path	integer	Yes	Internal order identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

An order

{"$ref":"#\/definitions\/order_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Order not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatron

GET /api/v1/patrons/{patron_id}
Operation ID: getPatron

Get patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A patron

{"$ref":"#\/definitions\/patron_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatronAccount

GET /api/v1/patrons/{patron_id}/account
Operation ID: getPatronAccount

Get account information for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier

Response 200

Patron's account balance

{"$ref":"#\/definitions\/patron_balance_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatronAttributes

GET /api/v1/patrons/{patron_id}/extended_attributes
Operation ID: getPatronAttributes

List extended attributes for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

The patron extended attributes

{"items":{"$ref":"#\/definitions\/patron_extended_attribute_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatronCheckouts

GET /api/v1/patrons/{patron_id}/checkouts
Operation ID: getPatronCheckouts

List checkouts for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

The patron checkouts

{"items":{"$ref":"#\/definitions\/checkout_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatronHolds

GET /api/v1/patrons/{patron_id}/holds
Operation ID: getPatronHolds

List holds for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
old	query	boolean	No	By default, current holds are returned, when this is true then old holds are returned as result.
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

The patron holds

{"items":{"$ref":"#\/definitions\/hold_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPatronRecalls

GET /api/v1/patrons/{patron_id}/recalls
Operation ID: getPatronRecalls

List recalls for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

The patron's recalls

{"items":{"$ref":"#\/definitions\/recall_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPreservationProcessings

GET /api/v1/preservation/processings/{processing_id}
Operation ID: getPreservationProcessings

Get processing

Parameters

Name	In	Type	Required	Description
processing_id	path	integer	Yes	processing internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A processing

{"items":{"$ref":"#\/definitions\/preservation_processing_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPreservationTrains

GET /api/v1/preservation/trains/{train_id}
Operation ID: getPreservationTrains

Get train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

A train

{"items":{"$ref":"#\/definitions\/preservation_train_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getPreservationconfig

GET /api/v1/preservation/config
Operation ID: getPreservationconfig

get the Preservation config

This resource returns a list of options needed for the Preservation Vue app. EXPERIMENTAL - DO NOT RELY on this, it is subject to change!

Parameters

This resource has no input parameters.

Response 200

The Preservation module config

{"$ref":"#\/definitions\/preservation_config_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getQuote

GET /api/v1/quotes/{quote_id}
Operation ID: getQuote

Get quote

Parameters

Name	In	Type	Required	Description
quote_id	path	integer	Yes	Quote internal identifier

Response 200

A Quote

{"$ref":"#\/definitions\/quote_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Quote not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getRenewals

GET /api/v1/checkouts/{checkout_id}/renewals
Operation ID: getRenewals

List renewals for a checkout

Parameters

Name	In	Type	Required	Description
checkout_id	path	integer	Yes	Internal checkout identifier
x-koha-embed	header	array	No	Embed list sent as a request header

Response 200

List of checkouts renewals

{"$ref":"#\/definitions\/renewals_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getSMTPServer

GET /api/v1/config/smtp_servers/{smtp_server_id}
Operation ID: getSMTPServer

Get SMTP server

Parameters

Name	In	Type	Required	Description
smtp_server_id	path	integer	Yes	SMTP server internal identifier

Response 200

An SMTP server object

{"$ref":"#\/definitions\/smtp_server_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

GET /api/v1/search_filters/{search_filter_id}
Operation ID: getSearchFilter

Get search filter

Parameters

Name	In	Type	Required	Description
search_filter_id	path	integer	Yes	Search filter internal identifier

Response 200

A search filter

{"$ref":"#\/definitions\/search_filter_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

SearchFilter not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getSuggestion

GET /api/v1/suggestions/{suggestion_id}
Operation ID: getSuggestion

Get purchase suggestion

This resource gives access to a specific purchase suggestion

Parameters

Name	In	Type	Required	Description
suggestion_id	path	integer	Yes	Internal suggestion identifier

Response 200

A suggestion

{"$ref":"#\/definitions\/suggestion_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Suggestion not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getSushiService

GET /api/v1/erm/sushi_service
Operation ID: getSushiService

Get the details for a sushi service from the counter registry

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A sushi service

{"items":{"$ref":"#\/definitions\/erm_sushi_service_yaml"}}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getTicket

GET /api/v1/tickets/{ticket_id}
Operation ID: getTicket

Get ticket

Parameters

Name	In	Type	Required	Description
ticket_id	path	integer	Yes	Internal ticket identifier

Response 200

A ticket

{"$ref":"#\/definitions\/ticket_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Ticket not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getVendor

GET /api/v1/acquisitions/vendors/{vendor_id}
Operation ID: getVendor

Get vendor

Parameters

Name	In	Type	Required	Description
vendor_id	path	integer	Yes	Vendor id

Response 200

A vendor

{"$ref":"#\/definitions\/vendor_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Vendor not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

getsharedAdvancedEditorMacro

GET /api/v1/advanced_editor/macros/shared/{advancededitormacro_id}
Operation ID: getsharedAdvancedEditorMacro

Get shared advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier

Response 200

A macro

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

AdvancedEditorMacro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

importErmEHoldingsTitles

POST /api/v1/erm/eholdings/local/titles/import
Operation ID: importErmEHoldingsTitles

Import local titles

Parameters

Name	In	Type	Required	Description
body	body	object	Yes	The list_id of the list to import

Body

{"additionalProperties":false,"properties":{"list_id":{"type":"string"},"package_id":{"type":"string"}},"type":"object"}

Response 201

Successfully enqueued the import job

{"additionalProperties":false,"properties":{"job_id":{"type":"string"}},"type":"object"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listAuthorisedValueCategories

GET /api/v1/authorised_value_categories
Operation ID: listAuthorisedValueCategories

List authorised value categories

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of authorised value categories

{"items":{"$ref":"#\/definitions\/authorised_value_category_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listAuthorisedValues

GET /api/v1/authorised_value_categories/{authorised_value_category_name}/authorised_values
Operation ID: listAuthorisedValues

List authorised values for a given category

Parameters

Name	In	Type	Required	Description
authorised_value_category_name	path	string	Yes	category name
authorised_value_id	query	integer	No	Case insensitive search on authorised value id
category_name	query	string	No	Case insensitive search on authorised value category name
value	query	string	No	Case insensitive search on value
description	query	string	No	Case insensitive search on description
opac_description	query	string	No	Case insensitive search on opac description
image_url	query	string	No	Case insensitive search on image url
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of authorised values

{"items":{"$ref":"#\/definitions\/authorised_value_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listAuthorities

GET /api/v1/authorities
Operation ID: listAuthorities

List authorities

Parameters

Name	In	Type	Required	Description
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of authorities

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Authority not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listBasketsManagers

GET /api/v1/acquisitions/baskets/managers
Operation ID: listBasketsManagers

List possibe managers for baskets

This resource returns a list of patron allowed to be a manager for baskets

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of orders' managers

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listBiblio

GET /api/v1/biblios
Operation ID: listBiblio

List biblios

Parameters

Name	In	Type	Required	Description
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of biblios

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listBiblioCheckouts

GET /api/v1/biblios/{biblio_id}/checkouts
Operation ID: listBiblioCheckouts

List checkouts for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header
checked_in	query	boolean	No	By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.

Body

{"type":"object"}

Response 200

A list of checkouts

{"$ref":"#\/definitions\/checkouts_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listBookings

GET /api/v1/bookings
Operation ID: listBookings

List bookings

Parameters

Name	In	Type	Required	Description
biblio_id	query	string	No	Case insensative search on booking biblio_id
item_id	query	string	No	Case insensative search on booking item_id
patron_id	query	string	No	Case insensative search on booking patron_id
start_date	query	string	No	Case Insensative search on booking start_date
end_date	query	string	No	Case Insensative search on booking end_date
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of bookings

{"items":{"$ref":"#\/definitions\/booking_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listCashups

GET /api/v1/cash_registers/{cash_register_id}/cashups
Operation ID: listCashups

List cashups for the cash register

Parameters

Name	In	Type	Required	Description
cash_register_id	path	integer	Yes	Cash register internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

Cashups performed on this register

{"items":{"$ref":"#\/definitions\/cashup_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listCheckouts

GET /api/v1/checkouts
Operation ID: listCheckouts

List checkouts

Parameters

Name	In	Type	Required	Description
patron_id	query	integer	No	Internal patron identifier
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
checked_in	query	boolean	No	By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of checkouts

{"$ref":"#\/definitions\/checkouts_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listCities

GET /api/v1/cities
Operation ID: listCities

List cities

Parameters

Name	In	Type	Required	Description
name	query	string	No	Case insensative search on city name
state	query	string	No	Case insensative search on city state
country	query	string	No	Case insensative search on city country
postal_code	query	string	No	Case Insensative search on city postal code
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of cities

{"items":{"$ref":"#\/definitions\/city_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listCounterRegisteredPlatforms

GET /api/v1/erm/counter_registry
Operation ID: listCounterRegisteredPlatforms

List platforms currently registered with the counter registry

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of counter registered platforms

{"items":{"$ref":"#\/definitions\/erm_counter_registry_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listERMUsers

GET /api/v1/erm/users
Operation ID: listERMUsers

List possibe users for ERM

This resource returns a list of patron allowed to be users of the ERM module

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of ERM' users

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmAgreements

GET /api/v1/erm/agreements
Operation ID: listErmAgreements

List agreements

Parameters

Name	In	Type	Required	Description
agreement_id	query	integer	No	Case insensitive search on agreement agreement_id
vendor_id	query	integer	No	Case insensitive search on agreement vendor_id
name	query	string	No	Case insensitive search on agreement name
description	query	string	No	Case insensitive search on agreement description
status	query	string	No	Case insensitive search on agreement status
closure_reason	query	string	No	Case insensitive search on agreement closure_reason
is_perpetual	query	boolean	No	Case insensitive search on agreement is_perpetual
renewal_priority	query	string	No	Case insensitive search on agreement renewal_priority
license_info	query	string	No	Case insensitive search on agreement license_info
max_expiration_date	query	string	No	filter by expired agreements
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of agreement

{"items":{"$ref":"#\/definitions\/erm_agreement_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmCounterFiles

GET /api/v1/erm/counter_files
Operation ID: listErmCounterFiles

List counter_files

Parameters

Name	In	Type	Required	Description
erm_counter_files_id	query	integer	No	Case insensitive search on counter_file erm_counter_files_id
usage_data_provider_id	query	integer	No	Case insensitive search on counter_file usage_data_provider_id
filename	query	string	No	Case insensitive search on counter_file filename
type	query	string	No	Case insensitive search on counter_file type
file_content	query	string	No	Case insensitive search on counter_file file_content
date_uploaded	query	string	No	Case insensitive search on counter_file date_uploaded
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of counter_files

{"items":{"$ref":"#\/definitions\/erm_counter_file_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmCounterLogs

GET /api/v1/erm/counter_logs
Operation ID: listErmCounterLogs

List counter_logs

Parameters

Name	In	Type	Required	Description
usage_data_provider_id	query	integer	No	Case insensitive search on counter_log usage_data_provider_id
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of counter_logs

{"items":{"$ref":"#\/definitions\/erm_counter_log_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmDefaultUsageReports

GET /api/v1/erm/default_usage_reports
Operation ID: listErmDefaultUsageReports

List default_usage_reports

Parameters

Name	In	Type	Required	Description
erm_default_usage_report_id	query	integer	No	Case insensitive search on erm_default_usage_report_id
report_name	query	integer	No	Case insensitive search on default_usage_report report_name
report_url_params	query	integer	No	Case insensitive search on default_usage_report report_url_params
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of default_usage_reports

{"items":{"$ref":"#\/definitions\/erm_default_usage_report_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmEHoldingsPackages

GET /api/v1/erm/eholdings/{provider}/packages
Operation ID: listErmEHoldingsPackages

List packages

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
package_id	query	string	No	Case insensitive search on package package_id
vendor_id	query	integer	No	Case insensitive search on package vendor_id
name	query	string	No	Case insensitive search on package name
external_package_id	query	integer	No	Case insensitive search on package external_package_id
package_type	query	string	No	Case insensitive search on package type
content_type	query	string	No	Case insensitive search on package content_type
notes	query	string	No	Case insensitive search on package notes
created_on	query	string	No	Case insensitive search on package creation date
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of package

{"items":{"$ref":"#\/definitions\/erm_eholdings_package_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmEHoldingsPackagesResources

GET /api/v1/erm/eholdings/{provider}/packages/{package_id}/resources
Operation ID: listErmEHoldingsPackagesResources

List eholdings resources

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
resource_id	query	string	No	Case insensitive search on resource_id
started_on	query	string	No	Case insensitive search on started_on
ended_on	query	string	No	Case insensitive search on ended_on
proxy	query	string	No	Case insensitive search on proxy
package_id	path	string	Yes	Package internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of eHoldings resources

{"items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmEHoldingsResources

GET /api/v1/erm/eholdings/{provider}/resources
Operation ID: listErmEHoldingsResources

List eholdings resources

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
resource_id	query	string	No	Case insensitive search on resource_id
package_id	query	string	No	Case insensitive search on package_id
vendor_id	query	integer	No	Case insensitive search on title vendor_id
started_on	query	string	No	Case insensitive search on started_on
ended_on	query	string	No	Case insensitive search on ended_on
proxy	query	string	No	Case insensitive search on proxy
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of eHoldings resources

{"items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmEHoldingsTitles

GET /api/v1/erm/eholdings/{provider}/titles
Operation ID: listErmEHoldingsTitles

List eholdings titles

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
title_id	query	integer	No	Case insensitive search on title title_id
publication_title	query	string	No	Case insensitive search on title publication_title
external_id	query	string	No	Case insensitive search on title external_id
print_identifier	query	string	No	Case insensitive search on title print_identifier
online_identifier	query	string	No	Case insensitive search on title online_identifier
date_first_issue_online	query	string	No	Case insensitive search on title date_first_issue_online
num_first_vol_online	query	string	No	Case insensitive search on title num_first_vol_online
num_first_issue_online	query	string	No	Case insensitive search on title num_first_issue_online
date_last_issue_online	query	string	No	Case insensitive search on title date_last_issue_online
num_last_vol_online	query	string	No	Case insensitive search on title num_last_vol_online
num_last_issue_online	query	string	No	Case insensitive search on title num_last_issue_online
title_url	query	string	No	Case insensitive search on title title_url
first_author	query	string	No	Case insensitive search on title first_author
embargo_info	query	string	No	Case insensitive search on title embargo_info
coverage_depth	query	string	No	Case insensitive search on title coverage_depth
notes	query	string	No	Case insensitive search on title notes
publisher_name	query	string	No	Case insensitive search on title publisher_name
publication_type	query	string	No	Case insensitive search on title publication_type
date_monograph_published_print	query	string	No	Case insensitive search on title date_monograph_published_print
date_monograph_published_online	query	string	No	Case insensitive search on title date_monograph_published_online
monograph_volume	query	string	No	Case insensitive search on title monograph_volume
monograph_edition	query	string	No	Case insensitive search on title monograph_edition
first_editor	query	string	No	Case insensitive search on title first_editor
parent_publication_title_id	query	string	No	Case insensitive search on title parent_publication_title_id
preceding_publication_title_id	query	string	No	Case insensitive search on title preceding_publication_title_id
access_type	query	string	No	Case insensitive search on title access_type
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of eHoldings titles

{"items":{"$ref":"#\/definitions\/erm_eholdings_title_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmEHoldingsTitlesResources

GET /api/v1/erm/eholdings/{provider}/titles/{title_id}/resources
Operation ID: listErmEHoldingsTitlesResources

List eholdings resources

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
resource_id	query	string	No	Case insensitive search on resource_id
started_on	query	string	No	Case insensitive search on started_on
ended_on	query	string	No	Case insensitive search on ended_on
proxy	query	string	No	Case insensitive search on proxy
title_id	path	integer	Yes	Title internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of eHoldings resources

{"items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmLicenses

GET /api/v1/erm/licenses
Operation ID: listErmLicenses

List licenses for agreements

Parameters

Name	In	Type	Required	Description
license_id	query	integer	No	Case insensitive search on license license_id
vendor_id	query	integer	No	Case insensitive search on agreement vendor_id
name	query	string	No	Case insensitive search on license name
type	query	string	No	Case insensitive search on license type
status	query	string	No	Case insensitive search on license status
started_on	query	string	No	Case insensitive search on license start date
ended_on	query	string	No	Case insensitive search on license end date
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of agreements' licenses

{"items":{"$ref":"#\/definitions\/erm_license_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmUsageDataProviders

GET /api/v1/erm/usage_data_providers
Operation ID: listErmUsageDataProviders

List usage_data_providers

Parameters

Name	In	Type	Required	Description
usage_data_provider_id	query	integer	No	Case insensitive search on usage_data_provider usage_data_provider_id
name	query	string	No	Case insensitive search on usage_data_provider name
description	query	string	No	Case insensitive search on usage_data_provider description
active	query	integer	No	Case insensitive search on usage_data_provider active
method	query	string	No	Case insensitive search on usage_data_provider method
aggregator	query	string	No	Case insensitive search on usage_data_provider aggregator
service_type	query	string	No	Case insensitive search on usage_data_provider service_type
service_url	query	string	No	Case insensitive search on usage_data_provider service_url
report_release	query	string	No	Case insensitive search on usage_data_provider report_release
customer_id	query	string	No	Case insensitive search on usage_data_provider customer_id
requestor_id	query	string	No	Case insensitive search on usage_data_provider requestor_id
api_key	query	string	No	Case insensitive search on usage_data_provider api_key
requestor_name	query	string	No	Case insensitive search on usage_data_provider requestor_name
requestor_email	query	string	No	Case insensitive search on usage_data_provider requestor_email
report_types	query	string	No	Case insensitive search on usage_data_provider report_types
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of usage_data_providers

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmUsageDatabases

GET /api/v1/erm/usage_databases
Operation ID: listErmUsageDatabases

List usage_databases

Parameters

Name	In	Type	Required	Description
database_id	query	integer	No	Case insensitive search on usage_database database_id
database	query	string	No	Case insensitive search on usage_database database
usage_data_provider_id	query	string	No	Case insensitive search on usage_database usage_data_provider_id
platform	query	string	No	Case insensitive search on usage_database platform
publisher	query	string	No	Case insensitive search on usage_database publisher
publisher_id	query	string	No	Case insensitive search on usage_title publisher_id
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of usage_databases

{"items":{"$ref":"#\/definitions\/erm_usage_database_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmUsageItems

GET /api/v1/erm/usage_items
Operation ID: listErmUsageItems

List usage_items

Parameters

Name	In	Type	Required	Description
item_id	query	integer	No	Case insensitive search on usage_item item_id
item	query	string	No	Case insensitive search on usage_item item
usage_data_provider_id	query	string	No	Case insensitive search on usage_item usage_data_provider_id
platform	query	string	No	Case insensitive search on usage_item platform
publisher	query	string	No	Case insensitive search on usage_item publisher
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of usage_items

{"items":{"$ref":"#\/definitions\/erm_usage_item_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmUsagePlatforms

GET /api/v1/erm/usage_platforms
Operation ID: listErmUsagePlatforms

List usage_platforms

Parameters

Name	In	Type	Required	Description
platform_id	query	integer	No	Case insensitive search on usage_platform platform_id
platform	query	string	No	Case insensitive search on usage_platform platform
usage_data_provider_id	query	string	No	Case insensitive search on usage_platform usage_data_provider_id
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of usage_platforms

{"items":{"$ref":"#\/definitions\/erm_usage_platform_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listErmUsageTitles

GET /api/v1/erm/usage_titles
Operation ID: listErmUsageTitles

List usage_titles

Parameters

Name	In	Type	Required	Description
title_id	query	integer	No	Case insensitive search on usage_title title_id
title	query	string	No	Case insensitive search on usage_title title
usage_data_provider_id	query	string	No	Case insensitive search on usage_title usage_data_provider_id
title_doi	query	string	No	Case insensitive search on usage_title title_doi
print_issn	query	string	No	Case insensitive search on usage_title print_issn
online_issn	query	string	No	Case insensitive search on usage_title online_issn
title_uri	query	string	No	Case insensitive search on usage_title title_uri
publisher	query	string	No	Case insensitive search on usage_title publisher
publisher_id	query	string	No	Case insensitive search on usage_title publisher_id
yop	query	string	No	Case insensitive search on usage_title yop
isbn	query	string	No	Case insensitive search on usage_title isbn
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of usage_titles

{"items":{"$ref":"#\/definitions\/erm_usage_title_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

GET /api/v1/search_filters
Operation ID: listFilters

List search filters

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of search filters

{"items":{"$ref":"#\/definitions\/search_filter_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listFunds

GET /api/v1/acquisitions/funds
Operation ID: listFunds

List funds

Parameters

Name	In	Type	Required	Description
name	query	string	No	Case insensitive search on fund name
fund_owner_id	query	integer	No	Display only the funds that belongs to the given patron ID
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of funds

{"items":{"$ref":"#\/definitions\/fund_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Fund not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listFundsOwners

GET /api/v1/acquisitions/funds/owners
Operation ID: listFundsOwners

List possibe owners for funds

This resource returns a list of patron allowed to be owner of funds

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of funds' owners

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listFundsUsers

GET /api/v1/acquisitions/funds/users
Operation ID: listFundsUsers

List possibe users for funds

This resource returns a list of patron allowed to be owner of funds

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of funds' users

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listHolds

GET /api/v1/holds
Operation ID: listHolds

List holds

Parameters

Name	In	Type	Required	Description
hold_id	query	integer	No	Internal hold identifier
patron_id	query	integer	No	Internal patron identifier
hold_date	query	string	No	Hold
biblio_id	query	integer	No	Internal biblio identifier
item_group_id	query	integer	No	Internal item group identifier
pickup_library_id	query	string	No	Internal library identifier for the pickup library
cancellation_date	query	string	No	The date the hold was cancelled
notes	query	string	No	Notes related to this hold
priority	query	integer	No	Where in the queue the patron sits
status	query	string	No	Found status
timestamp	query	string	No	Time of latest update
item_id	query	integer	No	Internal item identifier
waiting_date	query	string	No	Date the item was marked as waiting for the patron
expiration_date	query	string	No	Date the hold expires
lowest_priority	query	boolean	No	Lowest priority
suspended	query	boolean	No	Suspended
suspended_until	query	string	No	Suspended until
non_priority	query	boolean	No	Non priority hold
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
old	query	boolean	No	By default, current holds are returned, when this is true then old holds are returned as result.
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of holds

{"$ref":"#\/definitions\/holds_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Borrower not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIdentityProviderDomains

GET /api/v1/auth/identity_providers/{identity_provider_id}/domains
Operation ID: listIdentityProviderDomains

Get identity provider configured domains

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

An identity provider

{"items":{"$ref":"#\/definitions\/identity_provider_domain_yaml"}}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIdentityProviders

GET /api/v1/auth/identity_providers
Operation ID: listIdentityProviders

List configured identity providers

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of identity providers

{"items":{"$ref":"#\/definitions\/identity_provider_yaml"},"type":"array"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIllbackends

GET /api/v1/ill/backends
Operation ID: listIllbackends

List ILL backends

Parameters

This resource has no input parameters.

Response 200

A list of ILL backends

{"$ref":"#\/definitions\/ill_backends_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL backends not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIllbatches

GET /api/v1/ill/batches
Operation ID: listIllbatches

List ILL batches

Parameters

Name	In	Type	Required	Description
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of ILL batches

{"$ref":"#\/definitions\/ill_batches_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batches not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIllbatchstatuses

GET /api/v1/ill/batchstatuses
Operation ID: listIllbatchstatuses

List ILL batch statuses

Parameters

This resource has no input parameters.

Response 200

A list of ILL batch statuses

{"$ref":"#\/definitions\/ill_batchstatuses_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch statuses not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listIllrequests

GET /api/v1/ill/requests
Operation ID: listIllrequests

List ILL requests

Parameters

Name	In	Type	Required	Description
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of ILL requests

{"items":{"$ref":"#\/definitions\/ill_request_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listImportBatchProfiles

GET /api/v1/import_batch_profiles
Operation ID: listImportBatchProfiles

List batch import profiles

Parameters

Name	In	Type	Required	Description
name	query	string	No	Search on profile's name
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of import batch profiles

{"$ref":"#\/definitions\/import_batch_profiles_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listItemGroups

GET /api/v1/biblios/{biblio_id}/item_groups
Operation ID: listItemGroups

List item_groups

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of item_groups

{"items":{"$ref":"#\/definitions\/item_group_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listItemTypes

GET /api/v1/item_types
Operation ID: listItemTypes

List item types

Parameters

Name	In	Type	Required	Description
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of item types

{"items":{"$ref":"#\/definitions\/item_type_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listItems

GET /api/v1/items
Operation ID: listItems

List items

Parameters

Name	In	Type	Required	Description
external_id	query	string	No	Search on the item's barcode
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of item

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listItemsFromWaitingList

GET /api/v1/preservation/waiting-list/items
Operation ID: listItemsFromWaitingList

List items from waiting list

Parameters

Name	In	Type	Required	Description
external_id	query	string	No	Search on the item's barcode
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of item

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listItemsPublic

GET /api/v1/public/items
Operation ID: listItemsPublic

List items publically visible

Parameters

Name	In	Type	Required	Description
external_id	query	string	No	Search on the item's barcode
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of item

{"items":{"$ref":"#\/definitions\/item_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listJobs

GET /api/v1/jobs
Operation ID: listJobs

List jobs

Parameters

Name	In	Type	Required	Description
only_current	query	boolean	No	Only include current jobs
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of jobs

{"items":{"$ref":"#\/definitions\/job_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listLibraries

GET /api/v1/libraries
Operation ID: listLibraries

List libraries

Parameters

Name	In	Type	Required	Description
name	query	string	No	Case insensitive 'starts-with' search on name
address1	query	string	No	Case insensitive 'starts-with' search on address1
address2	query	string	No	Case insensitive 'starts-with' search on address2
address3	query	string	No	Case insensitive 'starts-with' search on address3
postal_code	query	string	No	Case insensitive 'starts-with' search on postal code
city	query	string	No	Case insensitive 'starts-with' search on city
state	query	string	No	Case insensitive 'starts-with' search on state
country	query	string	No	Case insensitive 'starts_with' search on country
phone	query	string	No	Case insensitive 'starts_with' search on phone number
fax	query	string	No	Case insensitive 'starts_with' search on fax number
email	query	string	No	Case insensitive 'starts_with' search on email address
reply_to_email	query	string	No	Case insensitive 'starts_with' search on Reply-To email address
return_path_email	query	string	No	Case insensitive 'starts_with' search on Return-Path email address
url	query	string	No	Case insensitive 'starts_with' search on website URL
ip	query	string	No	Case insensitive 'starts_with' search on IP address
notes	query	string	No	Case insensitive 'starts_with' search on notes
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of libraries

{"items":{"$ref":"#\/definitions\/library_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listLibrariesPublic

GET /api/v1/public/libraries
Operation ID: listLibrariesPublic

List libraries

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of libraries

{"items":{"$ref":"#\/definitions\/library_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listLibraryCashRegisters

GET /api/v1/libraries/{library_id}/cash_registers
Operation ID: listLibraryCashRegisters

List the library's cash registers

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of desks for the library

{"items":{"$ref":"#\/definitions\/cash_register_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listLibraryDesks

GET /api/v1/libraries/{library_id}/desks
Operation ID: listLibraryDesks

List the library's desks

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of desks for the library

{"items":{"$ref":"#\/definitions\/desk_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listMacro

GET /api/v1/advanced_editor/macros
Operation ID: listMacro

List advanced editor macros

Parameters

Name	In	Type	Required	Description
name	query	string	No	Case insensative search on macro name
macro_text	query	string	No	Case insensative search on macro text
patron_id	query	string	No	Search on internal patron_id
shared	query	string	No	Search on shared macros
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of macros

{"items":{"$ref":"#\/definitions\/advancededitormacro_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listOrders

GET /api/v1/acquisitions/orders
Operation ID: listOrders

List orders

Parameters

Name	In	Type	Required	Description
biblio_id	query	integer	No	Identifier for a linked bibliographic record
basket_id	query	integer	No	Identifier for a linked acquisition basket
fund_id	query	integer	No	Identifier for the fund the order goes against
status	query	string	No	Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'
only_active	query	boolean	No	If only active orders should be listed
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of orders

{"items":{"$ref":"#\/definitions\/order_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Order not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPatronCategories

GET /api/v1/patron_categories
Operation ID: listPatronCategories

List patron categories

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of patron categories

{"items":{"$ref":"#\/definitions\/patron_category_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPatronCredits

GET /api/v1/patrons/{patron_id}/account/credits
Operation ID: listPatronCredits

List patron credits

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of credits

{"items":{"$ref":"#\/definitions\/credit_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPatronDebits

GET /api/v1/patrons/{patron_id}/account/debits
Operation ID: listPatronDebits

List patron debits

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of debits

{"items":{"$ref":"#\/definitions\/debit_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPatrons

GET /api/v1/patrons
Operation ID: listPatrons

List patrons

Parameters

Name	In	Type	Required	Description
patron_id	query	string	No	Search on patron_id
cardnumber	query	string	No	Case insensitive search on cardnumber
surname	query	string	No	Case insensitive search on surname
firstname	query	string	No	Case insensitive search on firstname
title	query	string	No	Case insensitive search on title
other_name	query	string	No	Case insensitive search on othernames
initials	query	string	No	Case insensitive search on initials
street_number	query	string	No	Case insensitive search on streetnumber
street_type	query	string	No	Case insensitive search on streettype
address	query	string	No	Case insensitive search on address
address2	query	string	No	Case insensitive search on address2
city	query	string	No	Case insensitive search on city
state	query	string	No	Case insensitive search on state
postal_code	query	string	No	Case insensitive search on zipcode
country	query	string	No	Case insensitive search on country
email	query	string	No	Case insensitive search on email
phone	query	string	No	Case insensitive search on phone
mobile	query	string	No	Case insensitive search on mobile
fax	query	string	No	Case insensitive search on fax
secondary_email	query	string	No	Case insensitive search on secondary_email
secondary_phone	query	string	No	Case insensitive search on secondary_phone
altaddress_street_number	query	string	No	Case insensitive search on altaddress_street_number
altaddress_street_type	query	string	No	Case insensitive search on altaddress_street_type
altaddress_address	query	string	No	Case insensitive search on altaddress_address
altaddress_address2	query	string	No	Case insensitive search on altaddress_address2
altaddress_city	query	string	No	Case insensitive search on altaddress_city
altaddress_state	query	string	No	Case insensitive search on altaddress_state
altaddress_postal_code	query	string	No	Case insensitive search on altaddress_postal_code
altaddress_country	query	string	No	Case insensitive search on altaddress_country
altaddress_email	query	string	No	Case insensitive search on altaddress_email
altaddress_phone	query	string	No	Case insensitive search on altaddress_phone
date_of_birth	query	string	No	Case insensitive search on date_of_birth
library_id	query	string	No	Case insensitive search on library_id
category_id	query	string	No	Case insensitive search on category_id
date_enrolled	query	string	No	Case insensitive search on date_enrolled
expiry_date	query	string	No	Case insensitive search on expiry_date
incorrect_address	query	boolean	No	Search on incorrect_address
patron_card_lost	query	boolean	No	Search on patron_card_lost
restricted	query	boolean	No	Filter search by restricted
staff_notes	query	string	No	Case insensitive search on staff_notes
relationship_type	query	string	No	Case insensitive search on relationship_type
gender	query	string	No	Case insensitive search on gender
userid	query	string	No	Case insensitive search on userid
opac_notes	query	string	No	Case insensitive search on opac_notes
altaddress_notes	query	string	No	Case insensitive search on altaddress_notes
statistics_1	query	string	No	Case insensitive search on statistics_1
statistics_2	query	string	No	Case insensitive search on statistics_2
autorenew_checkouts	query	boolean	No	Search on autorenew_checkouts
altcontact_firstname	query	string	No	Case insensitive search on altcontact_firstname
altcontact_surname	query	string	No	Case insensitive search on altcontact_surname
altcontact_address	query	string	No	Case insensitive search on altcontact_address
altcontact_address2	query	string	No	Case insensitive search on altcontact_address2
altcontact_city	query	string	No	Case insensitive search on altcontact_city
altcontact_state	query	string	No	Case insensitive search on altcontact_state
altcontact_postal_code	query	string	No	Case insensitive search on altcontact_postal_code
altcontact_country	query	string	No	Case insensitive search on altcontact_country
altcontact_phone	query	string	No	Case insensitive search on altcontact_phone
sms_number	query	string	No	Case insensitive search on sms_number
sms_provider_id	query	string	No	Case insensitive search on sms_provider_id
privacy	query	string	No	Search on privacy
privacy_guarantor_checkouts	query	string	No	Search on privacy_guarantor_checkouts
check_previous_checkout	query	string	No	Case insensitive search on check_previous_checkout
updated_on	query	string	No	Search on updated_on
last_seen	query	string	No	Case insensitive search on last_seen
lang	query	string	No	Case insensitive search on lang
login_attempts	query	string	No	Search on login_attempts
protected	query	boolean	No	Search on protected status
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of patrons

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPreservationProcessings

GET /api/v1/preservation/processings
Operation ID: listPreservationProcessings

List processings

Parameters

Name	In	Type	Required	Description
processing_id	query	integer	No	Case insensitive search on processing id
name	query	string	No	Case insensitive search on processing name
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of processings

{"items":{"$ref":"#\/definitions\/preservation_processing_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listPreservationTrains

GET /api/v1/preservation/trains
Operation ID: listPreservationTrains

List trains

Parameters

Name	In	Type	Required	Description
train_id	query	integer	No	Case insensitive search on train id
name	query	string	No	Case insensitive search on train name
description	query	string	No	Case insensitive search on train description
not_for_loan	query	string	No	Case insensitive search on not for loan value
created_on	query	string	No	Case insensitive search on train creation date
closed_on	query	string	No	Case insensitive search on train closing date
sent_on	query	string	No	Case insensitive search on train sent date
received_on	query	string	No	Case insensitive search on train receiving date
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body

Body

{"type":"object"}

Response 200

A list of trains

{"items":{"$ref":"#\/definitions\/preservation_train_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listQuotes

GET /api/v1/quotes
Operation ID: listQuotes

List quotes

Parameters

Name	In	Type	Required	Description
quote_id	query	string	No	Case insensitive search on quote id
source	query	string	No	Case insensitive search on source
text	query	string	No	Case insensitive search on text
displayed_on	query	string	No	Case Insensative search on last displayed date
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of quotes

{"items":{"$ref":"#\/definitions\/quote_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listSMTPServers

GET /api/v1/config/smtp_servers
Operation ID: listSMTPServers

List SMTP servers

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of SMTP servers

{"items":{"$ref":"#\/definitions\/smtp_server_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listSuggestions

GET /api/v1/suggestions
Operation ID: listSuggestions

List purchase suggestions

This resource returns a list of purchase suggestions

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of suggestions

{"items":{"$ref":"#\/definitions\/suggestion_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listSuggestionsManagers

GET /api/v1/suggestions/managers
Operation ID: listSuggestionsManagers

List possibe managers for suggestions

This resource returns a list of patron allowed to be a manager for suggestions

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of suggestions' managers

{"items":{"$ref":"#\/definitions\/patron_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listTicketUpdates

GET /api/v1/tickets/{ticket_id}/updates
Operation ID: listTicketUpdates

List ticket updates

Parameters

Name	In	Type	Required	Description
ticket_id	path	integer	Yes	Internal ticket identifier
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of ticket updates

{"items":{"$ref":"#\/definitions\/ticket_update_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ticket not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listTickets

GET /api/v1/tickets
Operation ID: listTickets

List tickets

Parameters

Name	In	Type	Required	Description
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of tickets

{"items":{"$ref":"#\/definitions\/ticket_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listTransferLimits

GET /api/v1/transfer_limits
Operation ID: listTransferLimits

List transfer limits

This resource returns a list of existing transfer limits.

Parameters

Name	In	Type	Required	Description
to_library_id	query	string	No	Search on to_library_id
from_library_id	query	string	No	Search on from_library_id
item_type	query	string	No	Search on item_type
collection_code	query	string	No	Search on collection_code
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of transfer limits

{"items":{"$ref":"#\/definitions\/transfer_limit_yaml"},"type":"array"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listVendorIssues

GET /api/v1/acquisitions/vendors/{vendor_id}/issues
Operation ID: listVendorIssues

List vendor issues

Parameters

Name	In	Type	Required	Description
vendor_id	path	integer	Yes	Vendor id
issue_id	query	integer	No	Case insensitive search on issue's id
vendor_id	query	integer	No	Case insensitive search on vendor's id
type	query	string	No	Case insensitive search on issue type
started_on	query	string	No	Case insensitive search on issue start date
ended_on	query	string	No	Case insensitive search on issue end date
notes	query	string	No	Case insensitive search on issue's notes
x-koha-embed	header	array	No	Embed list sent as a request header
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header

Body

{"type":"object"}

Response 200

A list of issues

{"items":{"$ref":"#\/definitions\/vendor_issue_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

listVendors

GET /api/v1/acquisitions/vendors
Operation ID: listVendors

List vendors

Parameters

Name	In	Type	Required	Description
name	query	string	No	Case insensitive search on vendor name
accountnumber	query	string	No	Case insensitive search on vendor's account number
_match	query	string	No	Matching criteria
_order_by	query	array	No	Sorting criteria
_page	query	integer	No	Page number, for paginated object listing
_per_page	query	integer	No	Page size, for paginated object listing
q	query	array	No	Query filter sent as a request parameter
query	body	object	No	Query filter sent through request"s body
x-koha-request-id	header	integer	No	Request id header
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"type":"object"}

Response 200

A list of vendors

{"items":{"$ref":"#\/definitions\/vendor_yaml"},"type":"array"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Vendor not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

GET /api/v1/oauth/login/{provider_code}/{interface}
Operation ID: loginOAuthClient

Parameters

Name	In	Type	Required	Description
provider_code	path	string	Yes	Code for OAuth provider
interface	path	string	Yes	Name of the interface this login is for
code	query	string	No	Code returned from OAuth server for Authorization Code grant
state	query	string	No	An opaque value used by the client to maintain state between the request and callback. This is the callback part.
scope	query	string	No	Scope returned by OAuth server
prompt	query	string	No	Prompt returned by OAuth server
authuser	query	string	No	Auth user returned by OAuth server
error	query	string	No	OAuth error code
error_description	query	string	No	OAuth error description
error_uri	query	string	No	Web page with user friendly description of the error
session_state	query	string	No	Session state returned by OAuth server

Response 302

User authorized

{"type":"string"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

GET /api/v1/public/oauth/login/{provider_code}/{interface}
Operation ID: loginOAuthClientPublic

Parameters

Name	In	Type	Required	Description
provider_code	path	string	Yes	Code for OAuth provider
interface	path	string	Yes	Name of the interface this login is for
code	query	string	No	Code returned from OAuth server for Authorization Code grant
state	query	string	No	An opaque value used by the client to maintain state between the request and callback. This is the callback part.
scope	query	string	No	Scope returned by OAuth server
prompt	query	string	No	Prompt returned by OAuth server
authuser	query	string	No	Auth user returned by OAuth server
error	query	string	No	OAuth error code
error_description	query	string	No	OAuth error description
error_uri	query	string	No	Web page with user friendly description of the error
session_state	query	string	No	Session state returned by OAuth server

Response 302

User authorized

{"type":"string"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

mergeBiblios

POST /api/v1/biblios/{biblio_id}/merge
Operation ID: mergeBiblios

Merge Biblios

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Bilblionumber
body	body		Yes	JSON Object with params and an optional marc record in MARC-in-JSON format

Body

{"$ref":"#\/definitions\/merge_biblios_yaml"}

Response 200

The merge result as a biblio record

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

moveStage

PUT /api/v1/rotas/{rota_id}/stages/{stage_id}/position
Operation ID: moveStage

Update stage

Parameters

Name	In	Type	Required	Description
rota_id	path	integer	Yes	A rotas ID
stage_id	path	integer	Yes	A stages ID
position	body	integer	Yes	A stages position in the rota

Body

{"type":"integer"}

Response 200

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Position not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

overwriteHold

PUT /api/v1/holds/{hold_id}
Operation ID: overwriteHold

Update hold

This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH /holds/{hold_id} instead.

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":"string"},"priority":{"description":"Position in waiting queue","minimum":1,"type":"integer"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":"string"}},"type":"object"}

Response 200

Updated hold

{"$ref":"#\/definitions\/hold_yaml"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

overwritePatronAttributes

PUT /api/v1/patrons/{patron_id}/extended_attributes
Operation ID: overwritePatronAttributes

Overwrite extended attributes for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	array	Yes	A JSON representation of the patron extended attribute

Body

{"items":{"$ref":"#\/definitions\/patron_extended_attribute_yaml"},"type":"array"}

Response 200

The successfully created patron extended attributes

{"items":{"$ref":"#\/definitions\/patron_extended_attribute_yaml"},"type":"array"}

Response 400

Bad parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

processCOUNTERFileUsageDataProviderHarvester

POST /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}/process_COUNTER_file
Operation ID: processCOUNTERFileUsageDataProviderHarvester

Process COUNTER file upload for this data provider's harvester

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier
body	body		Yes	A JSON object containing information about the new counter_file

Body

{"$ref":"#\/definitions\/erm_counter_file_yaml"}

Response 200

Successful COUNTER file processing

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

processSUSHICounterUsageDataProviderHarvester

POST /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}/process_SUSHI_response
Operation ID: processSUSHICounterUsageDataProviderHarvester

Process SUSHI COUNTER for this data provider's harvester

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier
body	body	object	Yes	A JSON object with the begin and end dates

Body

{"additionalProperties":false,"properties":{"begin_date":{"description":"begin date of the harvest","format":"date","type":"string"},"end_date":{"description":"end date of the harvest","format":"date","type":"string"}},"type":"object"}

Response 200

Successful SUSHI COUNTER processing

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

publicCancelPatronArticleRequest

DELETE /api/v1/public/patrons/{patron_id}/article_requests/{article_request_id}
Operation ID: publicCancelPatronArticleRequest

Cancel patron's article requests

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
article_request_id	path	integer	Yes	Article request identifier
cancellation_reason	query	string	No	Article request cancellation reason
notes	query	string	No	Article request custom cancellation reason

Response 204

Patron's article request canceled

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

removeFromBundle

DELETE /api/v1/items/{item_id}/bundled_items/{bundled_item_id}
Operation ID: removeFromBundle

Remove item from bundle

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier
bundled_item_id	path	string	Yes	Internal identifier for the bundled item

Response 204

Bundle link deleted

null

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in creating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

removeItemFromTrain

DELETE /api/v1/preservation/trains/{train_id}/items/{train_item_id}
Operation ID: removeItemFromTrain

Remove item from train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
train_item_id	path	integer	Yes	train item internal identifier

Response 204

Item removed

null

Response 400

Item removal failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Item not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

removeItemFromWaitingList

DELETE /api/v1/preservation/waiting-list/items/{item_id}
Operation ID: removeItemFromWaitingList

Remove item from waiting list

Parameters

Name	In	Type	Required	Description
item_id	path	integer	Yes	Internal item identifier

Response 204

Item removed

null

Response 400

Item removal failed

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Item not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

renewCheckout

POST /api/v1/checkouts/{checkout_id}/renewal
Operation ID: renewCheckout

Renew a checkout

Parameters

Name	In	Type	Required	Description
checkout_id	path	integer	Yes	Internal checkout identifier
seen	query	integer	No	Item was seen flag

Response 201

Updated borrower's checkout

{"$ref":"#\/definitions\/checkout_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Cannot renew checkout

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

renewsCheckout

POST /api/v1/checkouts/{checkout_id}/renewals
Operation ID: renewsCheckout

Renew a checkout

Parameters

Name	In	Type	Required	Description
checkout_id	path	integer	Yes	Internal checkout identifier
seen	query	integer	No	Item was seen flag

Response 201

Updated borrower's checkout

{"$ref":"#\/definitions\/checkout_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Cannot renew checkout

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Checkout not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

resumeHold

DELETE /api/v1/holds/{hold_id}/suspension
Operation ID: resumeHold

Resume hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier

Response 204

Hold resumed

null

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

send_otp_token

POST /api/v1/auth/otp/token_delivery
Operation ID: send_otp_token

Send OTP token for second step authentication

Parameters

This resource has no input parameters.

Response 200

{"additionalProperties":false,"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer"},"token_type":{"type":"string"}},"type":"object"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

setBiblioRating

POST /api/v1/public/biblios/{biblio_id}/ratings
Operation ID: setBiblioRating

set biblio rating (public)

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
body	body	object	No	A JSON object containing rating information

Body

{"additionalProperties":false,"properties":{"rating":{"description":"the rating","type":["integer","null"]}},"required":["rating"],"type":"object"}

Response 200

Rating set

{"additionalProperties":false,"properties":{"average":{"description":"average rating","type":"number"},"count":{"description":"number of ratings","type":"integer"},"rating":{"description":"user's rating","type":["number","null"]}},"type":"object"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setChosen

PUT /api/v1/import_batches/{import_batch_id}/records/{import_record_id}/matches/chosen
Operation ID: setChosen

Set the chosen match for an import record ID

Parameters

Name	In	Type	Required	Description
import_batch_id	path	integer	Yes	An import_batch ID
import_record_id	path	integer	Yes	An import_record ID
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"candidate_match_id":{"description":"Candidate match to choose","type":"integer"}},"type":"object"}

Response 200

Match updated

null

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Match management not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Import record match not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setPatronGuarantorsCanSeeCharges

PUT /api/v1/public/patrons/{patron_id}/guarantors/can_see_charges
Operation ID: setPatronGuarantorsCanSeeCharges

Set if guarantors can see charges (public)

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	object	Yes	A boolean representing if guarantors should be able to see the patron's charges

Body

{"additionalProperties":false,"properties":{"allowed":{"type":"boolean"}},"type":"object"}

Response 200

Charges view policy for guarantors changed

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setPatronGuarantorsCanSeeCheckouts

PUT /api/v1/public/patrons/{patron_id}/guarantors/can_see_checkouts
Operation ID: setPatronGuarantorsCanSeeCheckouts

Set if guarantors can see checkouts

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	object	Yes	A boolean representing if guarantors should be able to see the patron's checkouts

Body

{"additionalProperties":false,"properties":{"allowed":{"type":"boolean"}},"type":"object"}

Response 200

Check-out view policy for guarantors changed

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setPatronPassword

POST /api/v1/patrons/{patron_id}/password
Operation ID: setPatronPassword

Set password for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	object	No	A JSON object containing password information

Body

{"additionalProperties":false,"properties":{"password":{"description":"New password (plain text)","type":"string"},"password_2":{"description":"Repeated new password (plain text)","type":"string"}},"required":["password","password_2"],"type":"object"}

Response 200

Password changed

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setPatronPasswordExpiration

PUT /api/v1/patrons/{patron_id}/password/expiration_date
Operation ID: setPatronPasswordExpiration

Set password expiration for a patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	object	No	A JSON object containing password expiration date

Body

{"additionalProperties":false,"properties":{"expiration_date":{"description":"Date to expire password","format":"date","type":"string"}},"required":["expiration_date"],"type":"object"}

Response 200

Password expiration changed

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

setPatronPasswordPublic

POST /api/v1/public/patrons/{patron_id}/password
Operation ID: setPatronPasswordPublic

Set password for a patron (public)

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body	object	No	A JSON object containing password information

Body

{"additionalProperties":false,"properties":{"old_password":{"description":"Patron's original password","type":"string"},"password":{"description":"New password (plain text)","type":"string"},"password_repeated":{"description":"Repeated new password (plain text)","type":"string"}},"required":["password","password_repeated","old_password"],"type":"object"}

Response 200

Password changed

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Patron not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

suspendHold

POST /api/v1/holds/{hold_id}/suspension
Operation ID: suspendHold

Suspend the hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
body	body	object	No	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"end_date":{"description":"Date the hold suspension expires","format":"date","type":"string"}},"type":"object"}

Response 201

Hold suspended

null

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Hold not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

testUsageDataProviderHarvester

GET /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}/test_connection
Operation ID: testUsageDataProviderHarvester

Test this data provider's harvester

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier

Response 200

Successful connection test

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

tokenOAuth

POST /api/v1/oauth/token
Operation ID: tokenOAuth

Get access token

Parameters

Name	In	Type	Required	Description
grant_type	formData	string	Yes	grant type (client_credentials)
client_id	formData	string	No	client id
client_secret	formData	string	No	client secret

Response 200

{"additionalProperties":false,"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer"},"token_type":{"type":"string"}},"type":"object"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

unsetChosen

DELETE /api/v1/import_batches/{import_batch_id}/records/{import_record_id}/matches/chosen
Operation ID: unsetChosen

Unset the chosen match for an import record ID

Parameters

Name	In	Type	Required	Description
import_batch_id	path	integer	Yes	An import_batch ID
import_record_id	path	integer	Yes	An import_record ID

Response 204

Matches unchosen

null

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Match management not allowed

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Import record matches not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateAdvancedEditorMacro

PUT /api/v1/advanced_editor/macros/{advancededitormacro_id}
Operation ID: updateAdvancedEditorMacro

Update advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier
body	body		Yes	An advanced editor macro object

Body

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 200

An advanced editor macro

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Macro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateAuthority

PUT /api/v1/authorities/{authority_id}
Operation ID: updateAuthority

Update authority

Parameters

Name	In	Type	Required	Description
authority_id	path	integer	Yes	Authority identifier
x-authority-type	header	string	No	Authority type code. Use when content type is not application/json

Response 200

An authority id

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Authority not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateBiblio

PUT /api/v1/biblios/{biblio_id}
Operation ID: updateBiblio

Update biblio

Updates a bibliographic record to Koha. An optional `x-framework-id` may be passed, to specify the cataloguing framework to be used (instead of the default). The request body is expected to contain a MARC record in the format specified by the `Content-type` header passed. Possible values for this headers and the corresponding record formats expected are listed below: * application/marcxml+xml: MARCXML * application/marc-in-json: MARC-in-JSON * application/marc: Raw USMARC binary data

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
x-framework-id	header	string	No	Framework id. Use when content type is not application/json
x-record-schema	header	string	No	March schema. One of MARC21 or UNIMARC
x-confirm-not-duplicate	header	integer	No	Confirm the posted element is not a duplicate

Response 200

A biblio

null

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 406

Not acceptable

{"description":"Accepted content-types","items":{"type":"string"},"type":"array"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateBiblioItem

PUT /api/v1/biblios/{biblio_id}/items/{item_id}
Operation ID: updateBiblioItem

Update an item for a biblio

Parameters

Name	In	Type	Required	Description
biblio_id	path	integer	Yes	Record internal identifier
item_id	path	integer	Yes	Internal item identifier
body	body		Yes	A JSON object containing information about the item

Body

{"$ref":"#\/definitions\/item_yaml"}

Response 200

Item updated

{"$ref":"#\/definitions\/item_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateBooking

PUT /api/v1/bookings/{booking_id}
Operation ID: updateBooking

Update booking

Parameters

Name	In	Type	Required	Description
booking_id	path	integer	Yes	Booking identifier
body	body		Yes	A booking object

Body

{"$ref":"#\/definitions\/booking_yaml"}

Response 200

A booking

{"$ref":"#\/definitions\/booking_yaml"}

Response 400

Client error

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Booking not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateCity

PUT /api/v1/cities/{city_id}
Operation ID: updateCity

Update city

Parameters

Name	In	Type	Required	Description
city_id	path	integer	Yes	City internal identifier
body	body		Yes	A city object

Body

{"$ref":"#\/definitions\/city_yaml"}

Response 200

A city

{"$ref":"#\/definitions\/city_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

City not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateClaimNotes

PUT /api/v1/return_claims/{claim_id}/notes
Operation ID: updateClaimNotes

Update notes

Parameters

Name	In	Type	Required	Description
claim_id	path	integer	Yes	Unique identifier for the claim whose notes are to be updated
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"notes":{"description":"Notes about this return claim","type":"string"},"updated_by":{"description":"Interal identifier for the librarian updating the claim notes","type":"string"}},"type":"object"}

Response 200

Claim notes updated

{"$ref":"#\/definitions\/return_claim_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Claim not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateClaimResolve

PUT /api/v1/return_claims/{claim_id}/resolve
Operation ID: updateClaimResolve

Resolve claim

Parameters

Name	In	Type	Required	Description
claim_id	path	integer	Yes	Unique identifier for the claim to be resolved
body	body	object	Yes	A JSON object containing fields to modify

Body

{"additionalProperties":false,"properties":{"new_lost_status":{"description":"New lost status to set to the item","type":"string"},"resolution":{"description":"The RETURN_CLAIM_RESOLUTION code to be used to resolve the calim","type":"string"},"resolved_by":{"description":"User id for the librarian resolving the claim","type":"string"}},"type":"object"}

Response 200

Claim resolved

{"$ref":"#\/definitions\/return_claim_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Claim not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateERMUsageDataProviders

PUT /api/v1/erm/usage_data_providers/{erm_usage_data_provider_id}
Operation ID: updateERMUsageDataProviders

update usage_data_provider

Parameters

Name	In	Type	Required	Description
erm_usage_data_provider_id	path	integer	Yes	ERM usage_data_provider internal identifier
body	body		Yes	a json object containing new information about existing usage_data_provider
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}

Response 200

a successfully updated usage_data_provider

{"items":{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}}

Response 400

bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateERMlicenses

PUT /api/v1/erm/licenses/{license_id}
Operation ID: updateERMlicenses

update license

Parameters

Name	In	Type	Required	Description
license_id	path	integer	Yes	License internal identifier
body	body		Yes	a json object containing new information about existing license
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/erm_license_yaml"}

Response 200

a successfully updated license

{"items":{"$ref":"#\/definitions\/erm_license_yaml"}}

Response 400

bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

internal server error. possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateErmAgreements

PUT /api/v1/erm/agreements/{agreement_id}
Operation ID: updateErmAgreements

Update agreement

Parameters

Name	In	Type	Required	Description
agreement_id	path	integer	Yes	Agreement internal identifier
body	body		Yes	A JSON object containing new information about existing agreement
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/erm_agreement_yaml"}

Response 200

A successfully updated agreement

{"items":{"$ref":"#\/definitions\/erm_agreement_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateErmEHoldingsPackages

PUT /api/v1/erm/eholdings/{provider}/packages/{package_id}
Operation ID: updateErmEHoldingsPackages

Update eHoldings package

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
package_id	path	string	Yes	Package internal identifier
body	body		Yes	A JSON object containing new information about existing package
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}

Response 200

A successfully updated package

{"items":{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateErmEHoldingsTitles

PUT /api/v1/erm/eholdings/{provider}/titles/{title_id}
Operation ID: updateErmEHoldingsTitles

Update titles

Parameters

Name	In	Type	Required	Description
provider	path	string	Yes	Provider name
title_id	path	integer	Yes	Title internal identifier
body	body		Yes	A JSON object containing new information about existing title
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}

Response 200

A successfully updated title

{"items":{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateHoldPickupLocation

PUT /api/v1/holds/{hold_id}/pickup_location
Operation ID: updateHoldPickupLocation

Update pickup location for the hold

Set a new pickup location for the hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
body	body	object	Yes	Pickup location

Body

{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal identifier for the pickup library","type":"string"}},"type":"object"}

Response 200

The new pickup location value for the hold

{"additionalProperties":false,"properties":{"pickup_library_id":{"description":"Internal identifier for the pickup library","type":"string"}},"type":"object"}

Response 400

Missing or wrong parameters

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Hold not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Unable to perform action on hold. Possible `error_code` attribute values: * `hold_waiting` * `hold_in_transit` * `hold_in_processing`

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

null

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateHoldPriority

PUT /api/v1/holds/{hold_id}/priority
Operation ID: updateHoldPriority

Update priority for the hold

Parameters

Name	In	Type	Required	Description
hold_id	path	integer	Yes	Internal hold identifier
body	body	integer	Yes	An integer representing the new priority to be set for the hold

Body

{"type":"integer"}

Response 200

The new priority value for the hold

{"type":"integer"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Biblio not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Unable to perform action on biblio

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateIdentityProvider

PUT /api/v1/auth/identity_providers/{identity_provider_id}
Operation ID: updateIdentityProvider

Update an identity provider

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
body	body		Yes	A JSON object containing OAuth provider parameters. The `config` object required attributes depends on the chosen `protocol` ## OAuth Requires: * key * secret * authorize_url * token_url ## OIDC Requires: * key * secret * well_known_url

Body

{"$ref":"#\/definitions\/identity_provider_yaml"}

Response 200

Updated identity provider

{"$ref":"#\/definitions\/identity_provider_yaml"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateIdentityProviderDomain

PUT /api/v1/auth/identity_providers/{identity_provider_id}/domains/{identity_provider_domain_id}
Operation ID: updateIdentityProviderDomain

Update an identity provider domain

Parameters

Name	In	Type	Required	Description
identity_provider_id	path	integer	Yes	Identity provider internal identifier
identity_provider_domain_id	path	integer	Yes	Identity provider domain internal identifier
body	body		Yes	An identity provider domain object

Body

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

Response 200

Updated identity provider domain

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

Response 400

Bad Request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateIllBatch

PUT /api/v1/ill/batches/{ill_batch_id}
Operation ID: updateIllBatch

Update batch

Parameters

Name	In	Type	Required	Description
ill_batch_id	path	integer	Yes	Internal ILL batch identifier
body	body		Yes	A JSON object containing information on the batch

Body

{"$ref":"#\/definitions\/ill_batch_yaml"}

Response 200

An ILL batch

{"$ref":"#\/definitions\/ill_batch_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateIllBatchstatus

PUT /api/v1/ill/batchstatuses/{ill_batchstatus_code}
Operation ID: updateIllBatchstatus

Update batch status

Parameters

Name	In	Type	Required	Description
ill_batchstatus_code	path	string	Yes	Internal ILL batch status identifier
body	body		Yes	A JSON object containing information on the batch status

Body

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

Response 200

An ILL batch status

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ILL batch status not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateItemFromTrain

PUT /api/v1/preservation/trains/{train_id}/items/{train_item_id}
Operation ID: updateItemFromTrain

Update item from train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
train_item_id	path	integer	Yes	train item internal identifier
body	body		Yes	An item
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 200

A successfully updated item

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateItemGroup

PUT /api/v1/biblios/{biblio_id}/item_groups/{item_group_id}
Operation ID: updateItemGroup

Update item group

Parameters

Name	In	Type	Required	Description
biblio_id	path	string	Yes	Internal identifier for the parent bibliographic record
item_group_id	path	string	Yes	Internal identifier for the item group
body	body	object	Yes	A JSON object with the new values for the item group
x-koha-embed	header	array	No	Embed list sent as a request header

Body

{"additionalProperties":false,"properties":{"description":{"description":"ItemGroup description","type":"string"},"display_order":{"description":"Position in waiting queue","type":"integer"}},"type":"object"}

Response 200

The updated item group

{"$ref":"#\/definitions\/item_group_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

ItemGroup not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateLibrary

PUT /api/v1/libraries/{library_id}
Operation ID: updateLibrary

Update library

Parameters

Name	In	Type	Required	Description
library_id	path	string	Yes	Internal library identifier
body	body		Yes	A JSON object containing information on the library

Body

{"$ref":"#\/definitions\/library_yaml"}

Response 200

A library

{"$ref":"#\/definitions\/library_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Library not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateOrder

PUT /api/v1/acquisitions/orders/{order_id}
Operation ID: updateOrder

Update order

Parameters

Name	In	Type	Required	Description
order_id	path	integer	Yes	Internal order identifier
body	body		Yes	A JSON object representing an order

Body

{"$ref":"#\/definitions\/order_yaml"}

Response 200

An order

{"$ref":"#\/definitions\/order_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Order not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updatePatron

PUT /api/v1/patrons/{patron_id}
Operation ID: updatePatron

Update patron

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
body	body		Yes	A JSON object containing new information about existing patron

Body

{"$ref":"#\/definitions\/patron_yaml"}

Response 200

A successfully updated patron

{"items":{"$ref":"#\/definitions\/patron_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Resource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updatePatronAttribute

PATCH /api/v1/patrons/{patron_id}/extended_attributes/{extended_attribute_id}
Operation ID: updatePatronAttribute

Update extended attribute

Parameters

Name	In	Type	Required	Description
patron_id	path	integer	Yes	Internal patron identifier
extended_attribute_id	path	integer	Yes	Internal patron extended attribute identifier
body	body	object	Yes	An object containing the updated values for the patron extended attribute

Body

{"additionalProperties":false,"properties":{"value":{"description":"Extended attribute value","type":"string"}},"type":"object"}

Response 200

A successfully updated patron extended attribute

{"$ref":"#\/definitions\/patron_extended_attribute_yaml"}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updatePreservationProcessings

PUT /api/v1/preservation/processings/{processing_id}
Operation ID: updatePreservationProcessings

Update processing

Parameters

Name	In	Type	Required	Description
processing_id	path	integer	Yes	processing internal identifier
body	body		Yes	A JSON object containing new information about existing processing

Body

{"$ref":"#\/definitions\/preservation_processing_yaml"}

Response 200

A successfully updated processing

{"items":{"$ref":"#\/definitions\/preservation_processing_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updatePreservationTrains

PUT /api/v1/preservation/trains/{train_id}
Operation ID: updatePreservationTrains

Update train

Parameters

Name	In	Type	Required	Description
train_id	path	integer	Yes	train internal identifier
body	body		Yes	A JSON object containing new information about existing train

Body

{"$ref":"#\/definitions\/preservation_train_yaml"}

Response 200

A successfully updated train

{"items":{"$ref":"#\/definitions\/preservation_train_yaml"}}

Response 400

Bad parameter

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ressource not found

{"$ref":"#\/definitions\/error_yaml"}

Response 409

Conflict in updating resource

{"$ref":"#\/definitions\/error_yaml"}

Response 413

Payload too large

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateQuote

PUT /api/v1/quotes/{quote_id}
Operation ID: updateQuote

Update quote

Parameters

Name	In	Type	Required	Description
quote_id	path	integer	Yes	Quote internal identifier
body	body		Yes	a quote object

Body

{"$ref":"#\/definitions\/quote_yaml"}

Response 200

A quote

{"$ref":"#\/definitions\/quote_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Quote not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateSMTPServer

PUT /api/v1/config/smtp_servers/{smtp_server_id}
Operation ID: updateSMTPServer

Update SMTP server

Parameters

Name	In	Type	Required	Description
smtp_server_id	path	integer	Yes	SMTP server internal identifier
body	body		Yes	An SMTP server object

Body

{"$ref":"#\/definitions\/smtp_server_yaml"}

Response 200

An SMTP server object

{"$ref":"#\/definitions\/smtp_server_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Object not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

PUT /api/v1/search_filters/{search_filter_id}
Operation ID: updateSearchFilter

Update search filter

Parameters

Name	In	Type	Required	Description
search_filter_id	path	integer	Yes	Search filter internal identifier
body	body		Yes	A search filter object

Body

{"$ref":"#\/definitions\/search_filter_yaml"}

Response 200

An search_filter

{"$ref":"#\/definitions\/search_filter_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Search filter not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateSuggestion

PUT /api/v1/suggestions/{suggestion_id}
Operation ID: updateSuggestion

Update purchase suggestion

This resource allows updating an existing purchase suggestion

Parameters

Name	In	Type	Required	Description
suggestion_id	path	integer	Yes	Internal suggestion identifier
body	body		Yes	A JSON object containing informations about the new hold

Body

{"$ref":"#\/definitions\/suggestion_yaml"}

Response 200

A suggestion

{"$ref":"#\/definitions\/suggestion_yaml"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Suggestion not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateTicket

PUT /api/v1/tickets/{ticket_id}
Operation ID: updateTicket

Update ticket

Parameters

Name	In	Type	Required	Description
ticket_id	path	integer	Yes	Internal ticket identifier
body	body		Yes	A ticket object

Body

{"$ref":"#\/definitions\/ticket_yaml"}

Response 200

A ticket

{"$ref":"#\/definitions\/ticket_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Ticket not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updateVendor

PUT /api/v1/acquisitions/vendors/{vendor_id}
Operation ID: updateVendor

Update vendor

Parameters

Name	In	Type	Required	Description
vendor_id	path	integer	Yes	Vendor id
body	body		Yes	A JSON object representing a vendor

Body

{"$ref":"#\/definitions\/vendor_yaml"}

Response 200

A vendor

{"$ref":"#\/definitions\/vendor_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Vendor not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

updatesharedAdvancedEditorMacro

PUT /api/v1/advanced_editor/macros/shared/{advancededitormacro_id}
Operation ID: updatesharedAdvancedEditorMacro

Update shared advanced editor macro

Parameters

Name	In	Type	Required	Description
advancededitormacro_id	path	integer	Yes	Advanced editor macro internal identifier
body	body		Yes	An advanced editor macro object

Body

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 200

An advanced editor macro

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

Response 400

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Macro not found

{"$ref":"#\/definitions\/error_yaml"}

Response 500

Internal error

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

validateUserAndPassword

POST /api/v1/auth/password/validation
Operation ID: validateUserAndPassword

Check validity of username and password

Parameters

Name	In	Type	Required	Description
body	body	object	No	A JSON object containing a patron identifier and password information. The identifier will be used to match patrons on the database using the following order: * userid * cardnumber Optionally, you can specify the `userid` attribute if you don't want it to be checked against the patron cardnumbers.

Body

{"additionalProperties":false,"properties":{"identifier":{"description":"A patron identifier (`userid` or `cardnumber`)","type":"string"},"password":{"description":"Password (plain text)","type":"string"},"userid":{"description":"A patron userid","type":"string"}},"required":["password"],"type":"object"}

Response 201

Validation successful

{"additionalProperties":false,"properties":{"cardnumber":{"description":"cardnumber for the validated patron","type":"string"},"patron_id":{"description":"Internal patron identifier","type":"integer"},"userid":{"description":"userid for the validated patron","type":"string"}},"type":"object"}

Response 400

Bad request

{"$ref":"#\/definitions\/error_yaml"}

Response 401

Authentication required

{"$ref":"#\/definitions\/error_yaml"}

Response 403

Access forbidden

{"$ref":"#\/definitions\/error_yaml"}

Response 404

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 500

Internal server error. Possible `error_code` attribute values: * `internal_server_error`

{"$ref":"#\/definitions\/error_yaml"}

Response 501

Default response.

{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

Under maintenance

{"$ref":"#\/definitions\/error_yaml"}

Parameters

advancededitormacro_id_pp

{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}

agreement_id_pp

{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"}

agreement_period_id_pp

{"description":"Agreement period internal identifier","in":"path","name":"agreement_period_id","required":true,"type":"integer"}

authorised_value_id_pp

{"description":"Authorised value internal identifier","in":"path","name":"authorised_value_id","required":true,"type":"integer"}

authority_id_pp

{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"}

authority_type_header

{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"}

biblio_id_pp

{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}

booking_id_pp

{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"}

candidate_match_id_pp

{"description":"Internal import record match identifier","in":"path","name":"candidate_match_id","required":true,"type":"integer"}

cash_register_id_pp

{"description":"Cash register internal identifier","in":"path","name":"cash_register_id","required":true,"type":"integer"}

cashup_id_pp

{"description":"Cashup internal identifier","in":"path","name":"cashup_id","required":true,"type":"integer"}

checkout_id_pp

{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"}

city_id_pp

{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"}

club_id_pp

{"description":"Internal club identifier","in":"path","name":"club_id","required":true,"type":"integer"}

confirm_not_duplicate_header

{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"}

data_type_pp

{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"}

eholdings_package_id_pp

{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"}

eholdings_resource_id_pp

{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"}

eholdings_title_id_pp

{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"}

erm_counter_files_id_pp

{"description":"ERM counter_files internal identifier","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"}

erm_counter_log_id_pp

{"description":"ERM counter_log internal identifier","in":"path","name":"erm_counter_log_id","required":true,"type":"integer"}

erm_default_usage_report_id_pp

{"description":"ERM default_usage_report internal identifier","in":"path","name":"erm_default_usage_report_id","required":true,"type":"integer"}

erm_usage_data_provider_id_pp

{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"}

framework_id_header

{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"}

fund_id_pp

{"description":"Fund id","in":"path","name":"fund_id","required":true,"type":"integer"}

hold_id_pp

{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"}

identity_provider_domain_id_pp

{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}

identity_provider_id_pp

{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"}

ill_batch_id_pp

{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"}

ill_batchstatus_code_pp

{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"}

import_batch_profile_id_pp

{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"}

import_record_id_pp

{"description":"Internal import record identifier","in":"path","name":"import_record_id","required":true,"type":"integer"}

item_id_pp

{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"}

item_id_qp

{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"}

job_id_pp

{"description":"Job internal identifier","in":"path","name":"job_id","required":true,"type":"integer"}

library_id_pp

{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"}

license_id_pp

{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"}

marc_schema_header

{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"}

match

{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"}

order_by

{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"}

order_id_pp

{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"}

page

{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"}

patron_id_pp

{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"}

patron_id_qp

{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"}

per_page

{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"}

preservation_processing_id_pp

{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"}

preservation_train_id_pp

{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"}

preservation_train_item_id_pp

{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"}

q_body

{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}

q_param

{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"}

quote_id_pp

{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"}

request_id_header

{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}

search_filter_id_pp

{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"}

seen_pp

{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"}

smtp_server_id_pp

{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"}

suggestion_id_pp

{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"}

swagger_yaml-parameters_advancededitormacro_id_pp

{"description":"Advanced editor macro internal identifier","in":"path","name":"advancededitormacro_id","required":true,"type":"integer"}

swagger_yaml-parameters_agreement_id_pp

{"description":"Agreement internal identifier","in":"path","name":"agreement_id","required":true,"type":"integer"}

swagger_yaml-parameters_authority_id_pp

{"description":"Authority identifier","in":"path","name":"authority_id","required":true,"type":"integer"}

swagger_yaml-parameters_authority_type_header

{"description":"Authority type code. Use when content type is not application\/json","in":"header","name":"x-authority-type","required":false,"type":"string"}

swagger_yaml-parameters_biblio_id_pp

{"description":"Record internal identifier","in":"path","name":"biblio_id","required":true,"type":"integer"}

swagger_yaml-parameters_booking_id_pp

{"description":"Booking identifier","in":"path","name":"booking_id","required":true,"type":"integer"}

swagger_yaml-parameters_cash_register_id_pp

{"description":"Cash register internal identifier","in":"path","name":"cash_register_id","required":true,"type":"integer"}

swagger_yaml-parameters_cashup_id_pp

{"description":"Cashup internal identifier","in":"path","name":"cashup_id","required":true,"type":"integer"}

swagger_yaml-parameters_checkout_id_pp

{"description":"Internal checkout identifier","in":"path","name":"checkout_id","required":true,"type":"integer"}

swagger_yaml-parameters_city_id_pp

{"description":"City internal identifier","in":"path","name":"city_id","required":true,"type":"integer"}

swagger_yaml-parameters_club_id_pp

{"description":"Internal club identifier","in":"path","name":"club_id","required":true,"type":"integer"}

swagger_yaml-parameters_confirm_not_duplicate_header

{"description":"Confirm the posted element is not a duplicate","in":"header","name":"x-confirm-not-duplicate","required":false,"type":"integer"}

swagger_yaml-parameters_data_type_pp

{"description":"ERM custom report data type","in":"path","name":"data_type","required":true,"type":"string"}

swagger_yaml-parameters_eholdings_package_id_pp

{"description":"Package internal identifier","in":"path","name":"package_id","required":true,"type":"string"}

swagger_yaml-parameters_eholdings_resource_id_pp

{"description":"Resource internal identifier","in":"path","name":"resource_id","required":true,"type":"string"}

swagger_yaml-parameters_eholdings_title_id_pp

{"description":"Title internal identifier","in":"path","name":"title_id","required":true,"type":"integer"}

swagger_yaml-parameters_erm_counter_files_id_pp

{"description":"ERM counter_files internal identifier","in":"path","name":"erm_counter_files_id","required":true,"type":"integer"}

swagger_yaml-parameters_erm_default_usage_report_id_pp

{"description":"ERM default_usage_report internal identifier","in":"path","name":"erm_default_usage_report_id","required":true,"type":"integer"}

swagger_yaml-parameters_erm_usage_data_provider_id_pp

{"description":"ERM usage_data_provider internal identifier","in":"path","name":"erm_usage_data_provider_id","required":true,"type":"integer"}

swagger_yaml-parameters_framework_id_header

{"description":"Framework id. Use when content type is not application\/json","in":"header","name":"x-framework-id","required":false,"type":"string"}

swagger_yaml-parameters_hold_id_pp

{"description":"Internal hold identifier","in":"path","name":"hold_id","required":true,"type":"integer"}

swagger_yaml-parameters_identity_provider_domain_id_pp

{"description":"Identity provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}

swagger_yaml-parameters_identity_provider_id_pp

{"description":"Identity provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"}

swagger_yaml-parameters_ill_batch_id_pp

{"description":"Internal ILL batch identifier","in":"path","name":"ill_batch_id","required":true,"type":"integer"}

swagger_yaml-parameters_ill_batchstatus_code_pp

{"description":"Internal ILL batch status identifier","in":"path","name":"ill_batchstatus_code","required":true,"type":"string"}

swagger_yaml-parameters_import_batch_profile_id_pp

{"description":"Internal profile identifier","in":"path","name":"import_batch_profile_id","required":true,"type":"integer"}

swagger_yaml-parameters_item_id_pp

{"description":"Internal item identifier","in":"path","name":"item_id","required":true,"type":"integer"}

swagger_yaml-parameters_item_id_qp

{"description":"Internal item identifier","in":"query","name":"item_id","type":"integer"}

swagger_yaml-parameters_job_id_pp

{"description":"Job internal identifier","in":"path","name":"job_id","required":true,"type":"integer"}

swagger_yaml-parameters_library_id_pp

{"description":"Internal library identifier","in":"path","name":"library_id","required":true,"type":"string"}

swagger_yaml-parameters_license_id_pp

{"description":"License internal identifier","in":"path","name":"license_id","required":true,"type":"integer"}

swagger_yaml-parameters_marc_schema_header

{"description":"March schema. One of MARC21 or UNIMARC","enum":["MARC21","UNIMARC"],"in":"header","name":"x-record-schema","required":false,"type":"string"}

swagger_yaml-parameters_match

{"description":"Matching criteria","enum":["contains","exact","starts_with","ends_with"],"in":"query","name":"_match","required":false,"type":"string"}

swagger_yaml-parameters_order_by

{"collectionFormat":"csv","description":"Sorting criteria","in":"query","items":{"type":"string"},"name":"_order_by","required":false,"type":"array"}

swagger_yaml-parameters_order_id_pp

{"description":"Internal order identifier","in":"path","name":"order_id","required":true,"type":"integer"}

swagger_yaml-parameters_page

{"description":"Page number, for paginated object listing","in":"query","name":"_page","required":false,"type":"integer"}

swagger_yaml-parameters_patron_id_pp

{"description":"Internal patron identifier","in":"path","name":"patron_id","required":true,"type":"integer"}

swagger_yaml-parameters_patron_id_qp

{"description":"Internal patron identifier","in":"query","name":"patron_id","type":"integer"}

swagger_yaml-parameters_per_page

{"description":"Page size, for paginated object listing","in":"query","name":"_per_page","required":false,"type":"integer"}

swagger_yaml-parameters_preservation_processing_id_pp

{"description":"processing internal identifier","in":"path","name":"processing_id","required":true,"type":"integer"}

swagger_yaml-parameters_preservation_train_id_pp

{"description":"train internal identifier","in":"path","name":"train_id","required":true,"type":"integer"}

swagger_yaml-parameters_preservation_train_item_id_pp

{"description":"train item internal identifier","in":"path","name":"train_item_id","required":true,"type":"integer"}

swagger_yaml-parameters_q_body

{"accepts":[],"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"},"type":"object"}

swagger_yaml-parameters_q_param

{"collectionFormat":"multi","description":"Query filter sent as a request parameter","in":"query","items":{"type":"string"},"name":"q","required":false,"type":"array"}

swagger_yaml-parameters_quote_id_pp

{"description":"Quote internal identifier","in":"path","name":"quote_id","required":true,"type":"integer"}

swagger_yaml-parameters_request_id_header

{"description":"Request id header","in":"header","name":"x-koha-request-id","required":false,"type":"integer"}

swagger_yaml-parameters_search_filter_id_pp

{"description":"Search filter internal identifier","in":"path","name":"search_filter_id","required":true,"type":"integer"}

swagger_yaml-parameters_seen_pp

{"description":"Item was seen flag","in":"query","name":"seen","required":false,"type":"integer"}

swagger_yaml-parameters_smtp_server_id_pp

{"description":"SMTP server internal identifier","in":"path","name":"smtp_server_id","required":true,"type":"integer"}

swagger_yaml-parameters_suggestion_id_pp

{"description":"Internal suggestion identifier","in":"path","name":"suggestion_id","required":true,"type":"integer"}

swagger_yaml-parameters_ticket_id_pp

{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"}

swagger_yaml-parameters_transfer_limit_id_pp

{"description":"Internal transfer limit identifier","in":"path","name":"limit_id","required":true,"type":"string"}

swagger_yaml-parameters_vendor_id_pp

{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"}

ticket_id_pp

{"description":"Internal ticket identifier","in":"path","name":"ticket_id","required":true,"type":"integer"}

transfer_limit_id_pp

{"description":"Internal transfer limit identifier","in":"path","name":"limit_id","required":true,"type":"string"}

vendor_id_pp

{"description":"Vendor id","in":"path","name":"vendor_id","required":true,"type":"integer"}

Definitions

account_line

{"$ref":"#\/definitions\/account_line_yaml"}

account_line_yaml

{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Account line amount","type":"number"},"amount_outstanding":{"description":"Outstanding amount","readOnly":true,"type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payment (if any)","type":["integer","null"]},"checkout_id":{"description":"Internal identifier for the checkout the account line is related to","type":["integer","null"]},"credit_number":{"description":"Internally generated identifier for credits","readOnly":true,"type":["string","null"]},"credit_type":{"description":"Account line credit type","type":["string","null"]},"date":{"description":"Date the account line was created","format":"date-time","readOnly":true,"type":"string"},"debit_type":{"description":"Account line debit type","type":["string","null"]},"description":{"description":"Account line description","readOnly":true,"type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","readOnly":true,"type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"item_id":{"description":"Internal identifier for the item the account line is related to","type":["integer","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","readOnly":true,"type":"integer"},"payment_type":{"description":"Payment type","type":["string","null"]},"payout_type":{"description":"Payout type","type":["string","null"]},"status":{"description":"The credit\/debit status","readOnly":true,"type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","readOnly":true,"type":"string"},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"}

advancededitormacro

{"$ref":"#\/definitions\/advancededitormacro_yaml"}

advancededitormacro_yaml

{"additionalProperties":false,"properties":{"macro_id":{"description":"Internal advanced editor macro identifier","readOnly":true,"type":"integer"},"macro_text":{"description":"macro text","type":["string","null"]},"name":{"description":"macro name","type":"string"},"patron_id":{"description":"borrower number","type":["integer","null"]},"shared":{"description":"is macro shared","type":["boolean","null"]}},"required":["name","macro_text","patron_id","shared"],"type":"object"}

allows_renewal

{"$ref":"#\/definitions\/allows_renewal_yaml"}

allows_renewal_yaml

{"additionalProperties":false,"properties":{"allows_renewal":{"description":"Renewability status; true = renewable, false = not renewable","type":"boolean"},"current_renewals":{"description":"Current used renewals","type":"integer"},"error":{"description":"Description on false allows_renewal.","type":["string","null"]},"max_renewals":{"description":"Maximum number of possible renewals","type":"integer"},"unseen_renewals":{"description":"Number of consecutive times the item was renewed without being seen","type":"integer"}},"type":"object"}

authorised_value

{"$ref":"#\/definitions\/authorised_value_yaml"}

authorised_value_category

{"$ref":"#\/definitions\/authorised_value_category_yaml"}

authorised_value_category_yaml

{"additionalProperties":false,"properties":{"authorised_values":{"description":"This category's authorised values","items":{"$ref":"#\/definitions\/authorised_value_yaml"},"type":"array"},"category_name":{"description":"Unique category name primary key","readOnly":true,"type":"string"},"is_system":{"description":"Is this category system or not","readOnly":true,"type":"boolean"}},"required":["category_name"],"type":"object"}

authorised_value_yaml

{"additionalProperties":false,"properties":{"authorised_value_id":{"description":"internally assigned authorised value identifier","readOnly":true,"type":"integer"},"category_name":{"description":"the category of this authorised value","type":"string"},"description":{"description":"The staff interface description for this authorised value","type":"string"},"image_url":{"description":"The url of the image associated with this authorised value, if any","type":["string","null"]},"opac_description":{"description":"The public interface description of this authorised value, if set\"","type":["string","null"]},"value":{"description":"The code for this authorised value","type":"string"}},"required":["category_name","value","description"],"type":"object"}

basket

{"$ref":"#\/definitions\/basket_yaml"}

basket_yaml

{"additionalProperties":false,"properties":{"authorised_by":{"description":"Internal patron identifier of the basket creator","type":["integer","null"]},"basket_group_id":{"description":"links this basket to its group (aqbasketgroups.id)","type":["integer","null"]},"basket_id":{"description":"Internal identifier for the basket","type":"integer"},"billing_library":{"description":"basket billing place","type":["string","null"]},"close_date":{"description":"The date the basket was closed","format":"date","type":["string","null"]},"contract_id":{"description":"Internal identifier of the linked contract","type":"integer"},"create_items":{"description":"When items should be created for orders in this basket (Options: 'ordering', 'receiving', 'cataloguing'. Null means system wide config)","enum":["ordering","receiving","cataloguing"],"type":"string"},"creation_date":{"description":"The date the basket was created","format":"date","type":["string","null"]},"delivery_library":{"description":"basket delivery place","type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"library_id":{"description":"Library the basket belongs to","type":["integer","null"]},"name":{"description":"Basket name","type":"string"},"standing":{"description":"If the orders in this basket are standing","type":"boolean"},"vendor_id":{"description":"Internal identifier for the vendor","type":"integer"},"vendor_note":{"description":"Vendor note","type":["string","null"]}},"type":"object"}

booking

{"$ref":"#\/definitions\/booking_yaml"}

booking_yaml

{"additionalProperties":false,"properties":{"biblio":{"description":"Embedable biblio representation","type":"object"},"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"booking_id":{"description":"Internal booking identifier","type":"integer"},"end_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"},"item":{"description":"Embedable item representation","type":["object","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"patron":{"description":"Embedable patron representation","type":["object","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"start_date":{"description":"Start date and time of this booking","format":"date-time","type":"string"}},"required":["biblio_id","item_id","patron_id","start_date","end_date"],"type":"object"}

bundle_link

{"$ref":"#\/definitions\/bundle_link_yaml"}

bundle_link_yaml

{"additionalProperties":false,"properties":{"external_id":{"description":"Item barcode","type":["string","null"]},"force_checkin":{"type":["boolean","null"]},"ignore_holds":{"type":["boolean","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]}},"type":"object"}

cash_register

{"$ref":"#\/definitions\/cash_register_yaml"}

cash_register_yaml

{"additionalProperties":false,"properties":{"archived":{"description":"If this till is archived","type":"boolean"},"cash_register_id":{"description":"Internal cash register identifier","type":"integer"},"description":{"description":"A description","type":"string"},"library_default":{"description":"If this till is the library default","type":"boolean"},"library_id":{"description":"Internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"name":{"description":"The cash register display name","type":"string"},"starting_float":{"description":"The starting float this account register should be assigned","type":["number","null"]}},"required":["cash_register_id","name","library_id"],"type":"object"}

cashup

{"$ref":"#\/definitions\/cashup_yaml"}

cashup_yaml

{"additionalProperties":false,"properties":{"amount":{"description":"Account line amount","type":"number"},"cash_register_id":{"description":"Internal identifier for the register the cashup belongs to","type":"integer"},"cashup_id":{"description":"Internal cashup identifier","type":"integer"},"manager":{"description":"The object representing the manager the cashup was performed by","type":["object","null"]},"manager_id":{"description":"Internal identifier for the manager the cashup was performed by","type":"integer"},"summary":{"description":"A summary of the cashup action","type":"object"},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","type":"string"}},"type":"object"}

checkout

{"$ref":"#\/definitions\/checkout_yaml"}

checkout_availability

{"$ref":"#\/definitions\/checkout_availability_yaml"}

checkout_availability_yaml

{"additionalProperties":false,"properties":{"blockers":{"description":"blocking issues","type":"object"},"confirmation_token":{"description":"token for confirmation","type":["string","null"]},"confirms":{"description":"issues requireing confirmation","type":"object"},"warnings":{"description":"informational issues","type":"object"}},"type":"object"}

checkout_yaml

{"additionalProperties":false,"properties":{"auto_renew":{"description":"Auto renewal","type":"boolean"},"auto_renew_error":{"description":"Auto renewal error","type":["string","null"]},"checkin_date":{"description":"Date the item was returned","format":"date-time","type":["string","null"]},"checkout_date":{"description":"Date the item was issued","format":"date-time","type":"string"},"checkout_id":{"description":"internally assigned checkout identifier","type":"integer"},"due_date":{"description":"Due date","format":"date-time","type":"string"},"issuer":{"description":"The object representing the checkout issuer","type":["object","null"]},"issuer_id":{"description":"internally assigned for the user that processed the checkout","type":["integer","null"]},"item":{"description":"The object representing the checked out item","type":["object","null"]},"item_id":{"description":"internal identifier of checked out item","type":["integer","null"]},"last_renewed_date":{"description":"Date the item was last renewed","format":"date-time","type":["string","null"]},"library":{"description":"The object representing the checkout library","type":["object","null"]},"library_id":{"description":"code of the library the item was checked out","type":["string","null"]},"note":{"description":"Issue note text","type":["string","null"]},"note_date":{"description":"Datetime of the issue note","format":"date","type":["string","null"]},"note_seen":{"description":"has the note been seen already","type":["boolean","null"]},"onsite_checkout":{"description":"On site checkout","type":"boolean"},"patron":{"description":"The object representing the checkout patron","type":["object","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"renewals_count":{"description":"Number of renewals","type":["integer","null"]},"timestamp":{"description":"Last update time","type":"string"},"unseen_renewals":{"description":"Number of consecutive unseen renewals","type":["integer","null"]}},"type":"object"}

checkouts

{"$ref":"#\/definitions\/checkouts_yaml"}

checkouts_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/checkout_yaml"},"type":"array"}

circ-rule-kind

{"$ref":"#\/definitions\/circ-rule-kind_yaml"}

circ-rule-kind_yaml

{"additionalProperties":false,"properties":{"scope":{"description":"levels that this rule kind can be set for","items":{"enum":["branchcode","categorycode","itemtype"],"type":"string"},"type":"array"}},"required":["scope"],"type":"object"}

city

{"$ref":"#\/definitions\/city_yaml"}

city_yaml

{"additionalProperties":false,"properties":{"city_id":{"description":"internally assigned city identifier","readOnly":true,"type":"integer"},"country":{"description":"city country","type":["string","null"]},"name":{"description":"city name","type":"string"},"postal_code":{"description":"city postal code","type":["string","null"]},"state":{"description":"city state","type":["string","null"]}},"required":["name","state","postal_code","country"],"type":"object"}

club_hold_yaml

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"club_hold_id":{"description":"Internal club hold identifier","type":"integer"},"club_id":{"description":"Internal club identifier","type":"integer"},"date_created":{"description":"Date and time the hold was created","format":"date-time","type":"string"},"item_id":{"description":"Internal item identifier","type":["string","null"]}},"type":"object"}

credit

{"$ref":"#\/definitions\/credit_yaml"}

credit_yaml

{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Credit amount","type":"number"},"amount_outstanding":{"description":"Outstanding amount","readOnly":true,"type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payment (if any)","type":["integer","null"]},"credit_number":{"description":"Internally generated identifier for credits","readOnly":true,"type":["string","null"]},"date":{"description":"Date the account line was created","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Account line description","readOnly":true,"type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","readOnly":true,"type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","readOnly":true,"type":"integer"},"payment_type":{"description":"Payment type","type":["string","null"]},"status":{"description":"The credit status","readOnly":true,"type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","readOnly":true,"type":"string"},"type":{"description":"Account credit type","type":["string","null"]},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"}

debit

{"$ref":"#\/definitions\/debit_yaml"}

debit_yaml

{"additionalProperties":false,"properties":{"account_line_id":{"description":"Internal account line identifier","readOnly":true,"type":["integer","null"]},"amount":{"description":"Debit amount","minimum":0,"type":"number"},"amount_outstanding":{"description":"Outstanding amount","type":"number"},"cash_register_id":{"description":"Internal identifier for the cash register used for the payout (if any)","type":["integer","null"]},"checkout_id":{"description":"Internal identifier for the checkout the account line is related to","type":["integer","null"]},"date":{"description":"Date the account line was created","format":"date-time","type":"string"},"description":{"description":"Account line description","type":["string","null"]},"interface":{"description":"Interface in which the account line was generated (values can be: api, cron, commandline, intranet, opac and sip)","type":["string","null"]},"internal_note":{"description":"Internal note","type":["string","null"]},"item_id":{"description":"Internal identifier for the item the account line is related to","type":["integer","null"]},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"patron_id":{"description":"Internal identifier for the patron the account line belongs to","type":"integer"},"payout_type":{"description":"Payout type","type":["string","null"]},"status":{"description":"The debit status","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","type":"string"},"type":{"description":"Account debit type","type":["string","null"]},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"required":["amount"],"type":"object"}

DefaultResponse

{"properties":{"errors":{"items":{"properties":{"message":{"type":"string"},"path":{"type":"string"}},"required":["message"],"type":"object"},"type":"array"}},"required":["errors"],"type":"object"}

desk

{"$ref":"#\/definitions\/desk_yaml"}

desk_yaml

{"additionalProperties":false,"properties":{"desk_id":{"description":"Internal desk identifier","type":"integer"},"library_id":{"description":"Internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"name":{"description":"The desk display name","type":"string"}},"required":["desk_id","name","library_id"],"type":"object"}

erm_agreement

{"$ref":"#\/definitions\/erm_agreement_yaml"}

erm_agreement_license_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"agreement_license_id":{"description":"Internal agreement license identifier","type":"integer"},"license_id":{"description":"Internal license identifier","type":"integer"},"notes":{"type":["string","null"]},"physical_location":{"type":["string","null"]},"status":{"type":"string"},"uri":{"type":["string","null"]}},"required":["license_id","status"],"type":"object"}

erm_agreement_period_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"agreement_period_id":{"description":"internally assigned identifier","readOnly":true,"type":"integer"},"cancellation_deadline":{"description":"Deadline for the cancellation","format":"date","type":["string","null"]},"ended_on":{"description":"End of the agreemnent period","format":"date","type":["string","null"]},"notes":{"type":["string","null"]},"started_on":{"description":"Start of the agreement period","format":"date","type":"string"}},"required":["started_on"],"type":"object"}

erm_agreement_relationship_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":"integer"},"notes":{"type":["string","null"]},"related_agreement_id":{"description":"Internal related agreement identifier","type":"integer"},"relationship":{"description":"relationship between the agreements","enum":["supersedes","is-superseded-by","provides_post-cancellation_access_for","has-post-cancellation-access-in","tracks_demand-driven_acquisitions_for","has-demand-driven-acquisitions-in","has_backfile_in","has_frontfile_in","related_to"],"type":"string"}},"required":["related_agreement_id","relationship"],"type":"object"}

erm_agreement_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"internally assigned agreement identifier","readOnly":true,"type":"integer"},"agreement_licenses":{"description":"agreement licenses","items":{"$ref":"#\/definitions\/erm_agreement_license_yaml"},"type":"array"},"agreement_relationships":{"description":"agreement relationships","items":{"$ref":"#\/definitions\/erm_agreement_relationship_yaml"},"type":"array"},"closure_reason":{"description":"reason of the closure","type":["string","null"]},"description":{"description":"description of the agreement","type":["string","null"]},"documents":{"description":"documents","items":{"$ref":"#\/definitions\/erm_document_yaml"},"type":"array"},"is_perpetual":{"description":"is the agreement perpetual","type":"boolean"},"license_info":{"description":"info about the license","type":["string","null"]},"name":{"description":"name of the agreement","type":"string"},"periods":{"description":"periods defined for this agreement","items":{"$ref":"#\/definitions\/erm_agreement_period_yaml"},"type":"array"},"renewal_priority":{"description":"priority of the renewal","type":["string","null"]},"status":{"description":"current status of the agreement","type":"string"},"user_roles":{"description":"role for users","items":{"$ref":"#\/definitions\/erm_user_role_yaml"},"type":"array"},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["agreement_id","name","status","is_perpetual"],"type":"object"}

erm_config

{"$ref":"#\/definitions\/erm_config_yaml"}

erm_config_yaml

{"additionalProperties":false,"properties":{"settings":{"description":"List of sysprefs used for the ERM module","type":"object"}},"type":"object"}

erm_counter_file

{"$ref":"#\/definitions\/erm_counter_file_yaml"}

erm_counter_file_yaml

{"additionalProperties":false,"properties":{"counter_logs":{"description":"counter logs","items":{"$ref":"#\/definitions\/erm_counter_log_yaml"},"type":"array"},"date_uploaded":{"description":"Timestamp for the date of upload","format":"date-time","type":"string"},"erm_counter_files_id":{"description":"internally assigned counter_files identifier","readOnly":true,"type":"integer"},"file_content":{"description":"file_content","type":"string"},"filename":{"description":"filename","type":"string"},"type":{"description":"type of the counter_files","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the counter_files","type":"integer"}},"required":["usage_data_provider_id","filename","file_content"],"type":"object"}

erm_counter_log

{"$ref":"#\/definitions\/erm_counter_log_yaml"}

erm_counter_log_yaml

{"additionalProperties":false,"properties":{"borrowernumber":{"description":"borrowernumber of the counter_log","type":["integer","null"]},"counter_files_id":{"description":"counter_files_id of the counter_log","type":["integer","null"]},"erm_counter_log_id":{"description":"internally assigned counter_log identifier","readOnly":true,"type":"integer"},"filename":{"description":"filename of the counter_file","type":["string","null"]},"importdate":{"description":"Timestamp for the date of upload","format":"date-time","type":"string"},"logdetails":{"description":"logdetails of the counter_log","type":["string","null"]},"usage_data_provider_id":{"description":"logdetails of the counter_log","type":["integer","null"]}},"required":["filename","borrowernumber","counter_files_id"],"type":"object"}

erm_counter_registry

{"$ref":"#\/definitions\/erm_counter_registry_yaml"}

erm_counter_registry_yaml

{"additionalProperties":false,"properties":{"abbrev":{"description":"abbrev of the platform","type":["string","null"]},"address":{"description":"current address of the platform","type":["string","null"]},"address_country":{"description":"current address country of the platform","type":["object","string"]},"audited":{"description":"has the record been audited?","type":"boolean"},"contact":{"description":"current contact of the platform","type":["object","null"]},"content_provider_name":{"description":"current content_provider_name of the platform","type":["string","null"]},"host_types":{"description":"host_types for the platform","items":{"type":"object"},"type":"array"},"id":{"description":"internally assigned identifier","type":"string"},"name":{"description":"name of the platform","type":"string"},"reports":{"description":"reports for the platform","items":{"type":"object"},"type":"array"},"sushi_services":{"description":"sushi_services for the platform","items":{"type":"object"},"type":"array"},"website":{"description":"current website of the platform","type":["string","null"]}},"type":"object"}

erm_custom_report

{"$ref":"#\/definitions\/erm_custom_report_yaml"}

erm_custom_report_yaml

{"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus_yaml"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus_yaml"},"type":"array"},"metric_type":{"description":"metric_type of the title data","type":["string","null"]},"online_issn":{"description":"online_issn number of the title","type":["string","null"]},"print_issn":{"description":"print_issn number of the title","type":["string","null"]},"provider_name":{"description":"provider_name of the title","type":["string","null"]},"publisher":{"description":"publisher of the title data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the title data","type":["string","null"]},"title":{"description":"title of the title","type":["string","null"]},"title_doi":{"description":"doi number of the title","type":["string","null"]},"title_id":{"description":"internally assigned title identifier","readOnly":true,"type":"integer"},"title_uri":{"description":"title_uri number of the title","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the title is harvested by","type":"integer"}},"type":"object"}

erm_default_usage_report

{"$ref":"#\/definitions\/erm_default_usage_report_yaml"}

erm_default_usage_report_yaml

{"additionalProperties":false,"properties":{"erm_default_usage_report_id":{"description":"internally assigned default_usage_report identifier","readOnly":true,"type":"integer"},"report_name":{"description":"report_name","type":"string"},"report_url_params":{"description":"report_url_params","type":"string"}},"required":["report_name","report_url_params"],"type":"object"}

erm_document_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"document_id":{"description":"internally assigned identifier","type":"integer"},"file_content":{"description":"Content of the file","type":["string","null"]},"file_description":{"description":"Description of the file","type":["string","null"]},"file_name":{"description":"Name of the file","type":["string","null"]},"file_type":{"description":"Type of the file","readOnly":true,"type":["string","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"notes":{"type":["string","null"]},"physical_location":{"description":"Physical location of the document","type":["string","null"]},"uploaded_on":{"description":"Datetime of the upload","format":"date-time","readOnly":true,"type":["string","null"]},"uri":{"description":"URI of the document","type":["string","null"]}},"type":"object"}

erm_eholdings_package

{"$ref":"#\/definitions\/erm_eholdings_package_yaml"}

erm_eholdings_package_agreement_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"foreign key to agreement","type":"integer"},"package_id":{"description":"foreign key to package","readOnly":true,"type":"integer"}},"required":["agreement_id"],"type":"object"}

erm_eholdings_package_yaml

{"additionalProperties":false,"properties":{"content_type":{"description":"content type of the package","type":["string","null"]},"created_on":{"description":"date of creation","type":["string","null"]},"external_id":{"description":"external id of the package","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"koha_internal_id":{"description":"internal id of the package","type":["integer","null"]},"name":{"description":"name of the package","type":"string"},"notes":{"description":"notes about the package","type":["string","null"]},"package_agreements":{"description":"agreements","items":{"$ref":"#\/definitions\/erm_eholdings_package_agreement_yaml"},"type":"array"},"package_id":{"description":"internally assigned package identifier","readOnly":true,"type":"string"},"package_type":{"description":"type of the package","type":["string","null"]},"provider":{"description":"external id of the package","type":["string","null"]},"resources":{"description":"resources","items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"},"resources_count":{"type":["integer","null"]},"vendor":{"type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["name"],"type":"object"}

erm_eholdings_resource

{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"}

erm_eholdings_resource_yaml

{"additionalProperties":false,"properties":{"ended_on":{"description":"End date","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"package":{"description":"Information about the package","type":["object","null"]},"package_id":{"description":"foreign key to the package","type":["string","null"]},"proxy":{"description":"Proxy to access this resource","type":["string","null"]},"resource_id":{"description":"internally assigned identifier","readOnly":true,"type":"string"},"started_on":{"description":"Start date","type":["string","null"]},"title":{"description":"Information about the title","type":["object","null"]},"title_id":{"description":"foreign key to the title","type":["integer","null"]},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["package_id"],"type":"object"}

erm_eholdings_title

{"$ref":"#\/definitions\/erm_eholdings_title_yaml"}

erm_eholdings_title_yaml

{"additionalProperties":false,"properties":{"access_type":{"description":"access_type of the title","type":["string","null"]},"biblio_id":{"description":"internally assigned identifier for the linked biblio","readOnly":true,"type":["integer","null"]},"coverage_depth":{"description":"coverage_depth of the title","type":["string","null"]},"date_first_issue_online":{"description":"date_first_issue_online of the title","type":["string","null"]},"date_last_issue_online":{"description":"date_last_issue_online of the title","type":["string","null"]},"date_monograph_published_online":{"description":"date_monograph_published_online of the title","type":["string","null"]},"date_monograph_published_print":{"description":"date_monograph_published_print of the title","type":["string","null"]},"embargo_info":{"description":"embargo_info of the title","type":["string","null"]},"external_id":{"description":"External id of the title","type":["string","null"]},"first_author":{"description":"first_author of the title","type":["string","null"]},"first_editor":{"description":"first_editor of the title","type":["string","null"]},"is_selected":{"description":"if the title is selected in the KB","type":["boolean","null"]},"monograph_edition":{"description":"monograph_edition of the title","type":["string","null"]},"monograph_volume":{"description":"monograph_volume of the title","type":["string","null"]},"notes":{"description":"notes of the title","type":["string","null"]},"num_first_issue_online":{"description":"num_first_issue_online of the title","type":["string","null"]},"num_first_vol_online":{"description":"num_first_vol_online of the title","type":["string","null"]},"num_last_issue_online":{"description":"num_last_issue_online of the title","type":["string","null"]},"num_last_vol_online":{"description":"num_last_vol_online of the title","type":["string","null"]},"online_identifier":{"description":"online_identifier of the title","type":["string","null"]},"parent_publication_title_id":{"description":"parent_publication_title_id of the title","type":["string","null"]},"preceding_publication_title_id":{"description":"preceding_publication_title_id of the title","type":["string","null"]},"print_identifier":{"description":"print_identifier of the title","type":["string","null"]},"publication_title":{"description":"publication_title of the title","type":"string"},"publication_type":{"description":"publication_type of the title","type":["string","null"]},"publisher_name":{"description":"publisher_name of the title","type":["string","null"]},"resources":{"description":"Resource containing this title","items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"},"title_id":{"description":"internally assigned identifier","readOnly":true,"type":"integer"},"title_url":{"description":"title_url of the title","type":["string","null"]}},"required":["publication_title"],"type":"object"}

erm_license

{"$ref":"#\/definitions\/erm_license_yaml"}

erm_license_yaml

{"additionalProperties":false,"properties":{"description":{"description":"description of the license","type":["string","null"]},"documents":{"description":"documents","items":{"$ref":"#\/definitions\/erm_document_yaml"},"type":"array"},"ended_on":{"description":"End of the license","format":"date","type":["string","null"]},"license_id":{"description":"internally assigned license identifier","readOnly":true,"type":"integer"},"name":{"description":"name of the license","type":"string"},"started_on":{"description":"Start of the license","format":"date","type":["string","null"]},"status":{"description":"status of the license","type":"string"},"type":{"description":"description of the license","type":"string"},"user_roles":{"description":"role for users","items":{"$ref":"#\/definitions\/erm_user_role_yaml"},"type":"array"},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["license_id","name","status","type"],"type":"object"}

erm_sushi_service

{"$ref":"#\/definitions\/erm_sushi_service_yaml"}

erm_sushi_service_yaml

{"additionalProperties":false,"properties":{"api_key_info":{"description":"api_key_info of the sushi service","type":["string","null"]},"api_key_required":{"description":"is api_key required","type":["boolean","null"]},"contact":{"description":"contact for the sushi service","items":{"type":"object"},"type":"array"},"counter_release":{"description":"counter_release of the sushi service","type":["string","null"]},"credentials_auto_expire":{"description":"do the credentials expire","type":["boolean","null"]},"credentials_auto_expire_info":{"description":"credentials_auto_expire_info of the sushi service","type":["string","null"]},"customer_id_info":{"description":"customer_id_info of the sushi service","type":["string","null"]},"customizations_in_place":{"description":"are any customizations in place","type":["boolean","null"]},"customizations_info":{"description":"customizations_info of the sushi service","type":["string","null"]},"data_host":{"description":"data_host of the sushi service","type":["string","null"]},"id":{"description":"internally assigned identifier","type":"string"},"ip_address_authorization":{"description":"is ip address auth required","type":["boolean","null"]},"ip_address_authorization_info":{"description":"ip_address_authorization_info of the sushi service","type":["string","null"]},"migrations":{"description":"migrations for the sushi service","items":{"type":"object"},"type":"array"},"notification_count":{"description":"notification count","type":["integer","null"]},"notifications_url":{"description":"notifications_url of the sushi service","type":["string","null"]},"platform_attr_required":{"description":"is platform_attr required","type":["boolean","null"]},"platform_specific_info":{"description":"platform_specific_info of the sushi service","type":["string","null"]},"request_volume_limits_applied":{"description":"are limits applied","type":["boolean","null"]},"request_volume_limits_info":{"description":"request_volume_limits_info of the sushi service","type":["string","null"]},"requestor_id_info":{"description":"requestor_id_info of the sushi service","type":["string","null"]},"requestor_id_required":{"description":"is requestor_id required","type":["boolean","null"]},"url":{"description":"url of the sushi service","type":["string","null"]}},"type":"object"}

erm_usage_data_provider

{"$ref":"#\/definitions\/erm_usage_data_provider_yaml"}

erm_usage_data_provider_yaml

{"additionalProperties":false,"properties":{"active":{"description":"status of the harvester","type":["integer","null"]},"aggregator":{"description":"aggregator of the harvester","type":["string","null"]},"api_key":{"description":"api_key of the harvester","type":["string","null"]},"counter_files":{"description":"counter files","items":{"$ref":"#\/definitions\/erm_counter_file_yaml"},"type":"array"},"customer_id":{"description":"customer_id of the harvester","type":["string","null"]},"description":{"description":"description of the data provider","type":["string","null"]},"earliest_database":{"description":"time period of data harvested","type":["string","null"]},"earliest_item":{"description":"time period of data harvested","type":["string","null"]},"earliest_platform":{"description":"time period of data harvested","type":["string","null"]},"earliest_title":{"description":"time period of data harvested","type":["string","null"]},"erm_usage_data_provider_id":{"description":"internally assigned data provider identifier","readOnly":true,"type":"integer"},"erm_usage_databases":{"description":"usage databases","items":{"$ref":"#\/definitions\/erm_usage_database_yaml"},"type":"array"},"erm_usage_items":{"description":"usage items","items":{"$ref":"#\/definitions\/erm_usage_item_yaml"},"type":"array"},"erm_usage_platforms":{"description":"usage platforms","items":{"$ref":"#\/definitions\/erm_usage_platform_yaml"},"type":"array"},"erm_usage_titles":{"description":"usage titles","items":{"$ref":"#\/definitions\/erm_usage_title_yaml"},"type":"array"},"last_run":{"description":"last time the harvester was run","type":["string","null"]},"latest_database":{"description":"time period of data harvested","type":["string","null"]},"latest_item":{"description":"time period of data harvested","type":["string","null"]},"latest_platform":{"description":"time period of data harvested","type":["string","null"]},"latest_title":{"description":"time period of data harvested","type":["string","null"]},"method":{"description":"method of the harvester","type":["string","null"]},"metric_type":{"description":"metric type of the harvester when reporting","type":["string","null"]},"name":{"description":"name of the data provider","type":"string"},"report_release":{"description":"report_release of the harvester","type":["string","null"]},"report_types":{"description":"report types of the harvester","type":["string","null"]},"requestor_email":{"description":"requestor_email of the harvester","type":["string","null"]},"requestor_id":{"description":"requestor_id of the harvester","type":["string","null"]},"requestor_name":{"description":"requestor_name of the harvester","type":["string","null"]},"service_type":{"description":"service_type of the harvester","type":["string","null"]},"service_url":{"description":"service_url of the harvester","type":["string","null"]}},"required":["name","customer_id","requestor_id","service_url","report_release"],"type":"object"}

erm_usage_database

{"$ref":"#\/definitions\/erm_usage_database_yaml"}

erm_usage_database_yaml

{"additionalProperties":false,"properties":{"database":{"description":"name of the database","type":["string","null"]},"database_id":{"description":"internally assigned database identifier","readOnly":true,"type":"integer"},"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus_yaml"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus_yaml"},"type":"array"},"platform":{"description":"name of the platform","type":["string","null"]},"publisher":{"description":"publisher of the database data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the database data","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the database is harvested by","type":"integer"}},"required":["database","usage_data_provider_id"],"type":"object"}

erm_usage_item

{"$ref":"#\/definitions\/erm_usage_item_yaml"}

erm_usage_item_yaml

{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus_yaml"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus_yaml"},"type":"array"},"item":{"description":"item of the item","type":["string","null"]},"item_id":{"description":"internally assigned item identifier","readOnly":true,"type":"integer"},"platform":{"description":"name of the platform","type":["string","null"]},"publisher":{"description":"publisher of the item data","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the item is harvested by","type":"integer"}},"required":["item","usage_data_provider_id"],"type":"object"}

erm_usage_mus

{"$ref":"#\/definitions\/erm_usage_mus_yaml"}

erm_usage_mus_yaml

{"additionalProperties":false,"properties":{"access_type":{"description":"access type of the monthly usage summary","type":["string","null"]},"database_id":{"description":"database_id of the monthly usage summary","type":["integer","null"]},"item_id":{"description":"item_id of the monthly usage summary","type":["integer","null"]},"metric_type":{"description":"metric type of the monthly usage summary","type":["string","null"]},"month":{"description":"month of the monthly usage summary","type":["integer","null"]},"monthly_usage_summary_id":{"description":"internally assigned monthly usage summary identifier","readOnly":true,"type":"integer"},"platform_id":{"description":"platform_id of the monthly usage summary","type":["integer","null"]},"report_type":{"description":"report type of the monthly usage summary","type":["string","null"]},"title_id":{"description":"title_id of the monthly usage summary","type":["integer","null"]},"usage_count":{"description":"total count of the monthly usage summary","type":["integer","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the monthly usage summary","type":["integer","null"]},"year":{"description":"year of the monthly usage summary","type":["integer","null"]},"yop":{"description":"year of publication of the monthly usage summary","type":["string","null"]}},"required":["title_id","usage_data_provider_id"],"type":"object"}

erm_usage_platform

{"$ref":"#\/definitions\/erm_usage_platform_yaml"}

erm_usage_platform_yaml

{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus_yaml"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus_yaml"},"type":"array"},"platform":{"description":"title of the platform","type":["string","null"]},"platform_id":{"description":"internally assigned platform identifier","readOnly":true,"type":"integer"},"usage_data_provider_id":{"description":"usage_data_provider the platform is harvested by","type":"integer"}},"required":["platform","usage_data_provider_id"],"type":"object"}

erm_usage_title

{"$ref":"#\/definitions\/erm_usage_title_yaml"}

erm_usage_title_yaml

{"additionalProperties":false,"properties":{"erm_usage_muses":{"description":"usage mus","items":{"$ref":"#\/definitions\/erm_usage_mus_yaml"},"type":"array"},"erm_usage_yuses":{"description":"usage yus","items":{"$ref":"#\/definitions\/erm_usage_yus_yaml"},"type":"array"},"isbn":{"description":"isbn of the title","type":["string","null"]},"metric_type":{"description":"metric_type of the title data","type":["string","null"]},"online_issn":{"description":"online_issn number of the title","type":["string","null"]},"platform":{"description":"platform of the title","type":["string","null"]},"print_issn":{"description":"print_issn number of the title","type":["string","null"]},"proprietary_id":{"description":"proprietary_id of the title","type":["string","null"]},"provider_name":{"description":"provider_name of the title","type":["string","null"]},"publisher":{"description":"publisher of the title data","type":["string","null"]},"publisher_id":{"description":"publisher_id of the title data","type":["string","null"]},"title":{"description":"title of the title","type":["string","null"]},"title_doi":{"description":"doi number of the title","type":["string","null"]},"title_id":{"description":"internally assigned title identifier","readOnly":true,"type":"integer"},"title_uri":{"description":"title_uri number of the title","type":["string","null"]},"usage_data_provider_id":{"description":"usage_data_provider the title is harvested by","type":"integer"}},"required":["title","usage_data_provider_id"],"type":"object"}

erm_usage_yus

{"$ref":"#\/definitions\/erm_usage_yus_yaml"}

erm_usage_yus_yaml

{"additionalProperties":false,"properties":{"access_type":{"description":"access type of the yearly usage summary","type":["string","null"]},"database_id":{"description":"database_id of the yearly usage summary","type":["integer","null"]},"item_id":{"description":"item_id of the yearly usage summary","type":["integer","null"]},"metric_type":{"description":"metric type of the yearly usage summary","type":["string","null"]},"platform_id":{"description":"platform_id of the yearly usage summary","type":["integer","null"]},"report_type":{"description":"report type of the yearly usage summary","type":["string","null"]},"title_id":{"description":"title_id of the yearly usage summary","type":["integer","null"]},"totalcount":{"description":"total count of the yearly usage summary","type":["integer","null"]},"usage_data_provider_id":{"description":"usage_data_provider_id of the yearly usage summary","type":["integer","null"]},"year":{"description":"year of the yearly usage summary","type":["integer","null"]},"yearly_usage_summary_id":{"description":"internally assigned yearly usage summary identifier","readOnly":true,"type":"integer"},"yop":{"description":"year of publication of the yearly usage summary","type":["string","null"]}},"required":["title_id","usage_data_provider_id"],"type":"object"}

erm_user_role_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"patron":{"type":["object","null"]},"role":{"description":"role of the user","type":["string"]},"user_id":{"description":"Internal patron identifier","type":"integer"},"user_role_id":{"description":"Internal user_role identifier","type":"integer"}},"required":["user_id","role"],"type":"object"}

error

{"$ref":"#\/definitions\/error_yaml"}

error_yaml

{"additionalProperties":true,"properties":{"error":{"description":"Error message","type":"string"},"error_code":{"description":"Error code","type":"string"}},"type":"object"}

fund

{"$ref":"#\/definitions\/fund_yaml"}

fund_yaml

{"additionalProperties":false,"properties":{"budget_id":{"description":"Internal identifier for the budget","type":["number","null"]},"code":{"description":"Code assigned to the fund by the user","type":["string","null"]},"fund_access":{"description":"Level of permission for this fund (1: owner, 2: owner, users and library, 3: owner and users)","type":["number","null"]},"fund_id":{"description":"internally assigned fund identifier","readOnly":true,"type":"integer"},"fund_owner_id":{"description":"Internal identifier for the fund owner","type":["number","null"]},"library_id":{"description":"Internal identifier for the library that this fund belongs to","type":["string","null"]},"name":{"description":"Name assigned to the fund by the user","type":["string","null"]},"notes":{"description":"Notes related to this fund","type":["string","null"]},"parent_fund_id":{"description":"Internal identifier for parent fund","type":["integer","null"]},"statistic1_auth_value_category":{"description":"Statistical category for this fund","type":["string","null"]},"statistic2_auth_value_category":{"description":"Second statistical category for this fund","type":["string","null"]},"timestamp":{"description":"Timestamp","format":"date-time","type":["string"]},"total_amount":{"description":"Total amount for this fund","type":["number","null"]},"warn_at_amount":{"description":"Warning at amount","type":["number","null"]},"warn_at_percentage":{"description":"Warning at percentage","type":["number","null"]}},"required":["name"],"type":"object"}

hold

{"$ref":"#\/definitions\/hold_yaml"}

hold_yaml

{"additionalProperties":false,"properties":{"biblio":{"description":"Bibliographic record","type":["object","null"]},"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"cancellation_date":{"description":"The date the hold was cancelled","format":"date","type":["string","null"]},"cancellation_reason":{"description":"The reason the hold was cancelled","type":["string","null"]},"cancellation_requested":{"description":"Cancellation requests count for the hold (x-koha-embed)","type":["boolean","null"]},"desk_id":{"description":"The id of the desk","type":["integer","null"]},"expiration_date":{"description":"The date the hold expires","format":"date","type":["string","null"]},"hold_date":{"description":"The date the hold was placed","format":"date","type":["string","null"]},"hold_id":{"description":"Internal hold identifier","type":"integer"},"item":{"description":"The item","type":["object","null"]},"item_group_id":{"description":"Internal item group identifier","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["string","null"]},"item_level":{"description":"If the hold is placed at item level","type":"boolean"},"item_type":{"description":"If record level hold, the optional itemtype of the item the patron is requesting","type":["string","null"]},"lowest_priority":{"description":"Controls if the hold is given the lowest priority on the queue","type":"boolean"},"non_priority":{"description":"Set this hold as non priority","type":"boolean"},"notes":{"description":"Notes related to this hold","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library":{"description":"Pickup library","type":["object","null"]},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":["string","null"]},"priority":{"description":"Where in the queue the patron sits","type":["integer","null"]},"status":{"description":"A one letter code defining what the status of the hold is after it has been confirmed","type":["string","null"]},"suspended":{"description":"Controls if the hold is suspended","type":"boolean"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest hold update","format":"date-time","type":"string"},"waiting_date":{"description":"The date the item was marked as waiting for the patron at the library","format":"date","type":["string","null"]}},"type":"object"}

holds

{"$ref":"#\/definitions\/holds_yaml"}

holds_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/hold_yaml"},"type":"array"}

identity_provider

{"$ref":"#\/definitions\/identity_provider_yaml"}

identity_provider_domain

{"$ref":"#\/definitions\/identity_provider_domain_yaml"}

identity_provider_domain_yaml

{"additionalProperties":false,"properties":{"allow_opac":{"description":"If this domain can be used for OPAC login","type":"boolean"},"allow_staff":{"description":"If this domain can be used for staff login","type":"boolean"},"auto_register":{"description":"If patrons will be generated on login if required","type":"boolean"},"default_category_id":{"description":"Internal identifier for the default patron's category","type":["string","null"]},"default_library_id":{"description":"Internal identifier for the default library to be assigned to the new patrons","type":["string","null"]},"domain":{"description":"Matching domain ('*' used as wildcard)","type":["string","null"]},"identity_provider_domain_id":{"description":"Internally assigned identity provider domain identifier","readOnly":true,"type":"integer"},"identity_provider_id":{"description":"Internally assigned identity provider identifier","type":"integer"},"update_on_auth":{"description":"If patron data is updated on login","type":"boolean"}},"required":["identity_provider_domain_id","domain","auto_register","update_on_auth","default_library_id","default_category_id","allow_opac","allow_staff"],"type":"object"}

identity_provider_yaml

{"additionalProperties":false,"properties":{"code":{"description":"Identity provider code","type":"string"},"config":{"description":"Configuration","type":"object"},"description":{"description":"User-oriented description for the provider","type":"string"},"domains":{"description":"Configured domains for the identity provider","type":["array","null"]},"icon_url":{"description":"Icon url","type":["string","null"]},"identity_provider_id":{"description":"Internally assigned identity provider identifier","readOnly":true,"type":"integer"},"mapping":{"description":"Attribute mapping","type":["object","null"]},"matchpoint":{"description":"Patron attribute that will be used to match","enum":["email","userid","cardnumber"],"type":"string"},"protocol":{"description":"Authentication protocol","enum":["OAuth","OIDC","CAS (not implemented)","LDAP (not implemented)"],"type":"string"}},"required":["config","code","protocol"],"type":"object"}

ill_backend

{"$ref":"#\/definitions\/ill_backend_yaml"}

ill_backend_yaml

{"additionalProperties":false,"properties":{"capabilities":{"description":"List of capabilities","type":"object"},"ill_backend_id":{"description":"Internal ILL backend identifier","type":"string"},"statuses":{"description":"existing statuses","items":{"$ref":"#\/definitions\/ill_status_yaml"},"type":"array"}},"type":"object"}

ill_backends

{"$ref":"#\/definitions\/ill_backends_yaml"}

ill_backends_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_backend_yaml"},"type":"array"}

ill_batch

{"$ref":"#\/definitions\/ill_batch_yaml"}

ill_batch_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"Expanded coded fields (x-koha-embed)","type":["object","null"]},"backend":{"description":"Backend name","type":"string"},"cardnumber":{"description":"Library assigned user identifier of the ILL batch","type":"string"},"ill_batch_id":{"description":"Internal ILL batch identifier","type":"integer"},"library":{"description":"The library associated with the batch","type":["object","null"]},"library_id":{"description":"Internal identifier for the ILL batch's library","type":"string"},"name":{"description":"Name of the ILL batch","type":"string"},"patron":{"description":"The patron associated with the batch","type":["object","null"]},"patron_id":{"description":"Internal identifier the patron of the ILL batch","type":"string"},"requests":{"description":"The requests in this batch (x-koha-embed)","type":["array","null"]},"requests_count":{"description":"The number of requests in this batch (x-koha-embed)","type":["integer","null"]},"status":{"description":"The status associated with the batch (x-koha-embed)","type":["object","null"]},"status_code":{"description":"Code of the status of the ILL batch","type":"string"}},"required":["name","backend","library_id","status_code"],"type":"object"}

ill_batches

{"$ref":"#\/definitions\/ill_batches_yaml"}

ill_batches_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_batch_yaml"},"type":"array"}

ill_batchstatus

{"$ref":"#\/definitions\/ill_batchstatus_yaml"}

ill_batchstatus_yaml

{"additionalProperties":false,"properties":{"code":{"description":"Unique, immutable status code","type":"string"},"id":{"description":"Internal ILL batch status identifier","type":"string"},"is_system":{"description":"Is this status required for system operation","type":"boolean"},"name":{"description":"Status name","type":"string"}},"required":["name","code","is_system"],"type":"object"}

ill_batchstatuses

{"$ref":"#\/definitions\/ill_batchstatuses_yaml"}

ill_batchstatuses_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_batchstatus_yaml"},"type":"array"}

ill_request

{"$ref":"#\/definitions\/ill_request_yaml"}

ill_request_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"Expanded coded fiels (x-koha-embed)","type":["object","null"]},"access_url":{"description":"A URL for accessing the item","type":["string","null"]},"biblio":{"description":"The linked biblio object (x-koha-embed)","type":["object","null"]},"biblio_id":{"description":"Internal bibliographic record identifier","type":["integer","null"]},"comments":{"description":"The linked comment objects (x-koha-embed)","type":["array","null"]},"comments_count":{"description":"The linked comment objects count (x-koha-embed)","type":["integer","null"]},"completed_date":{"description":"Date the request was marked as completed","format":"date","type":["string","null"]},"cost":{"description":"Default request cost","type":["string","null"]},"due_date":{"description":"Date and time the request item should be due when checked out","format":"date-time","type":["string","null"]},"extended_attributes":{"description":"The linked extended ill request attributes (x-koha-embed)","type":["array","null"]},"id_prefix":{"description":"The id_prefix of the request (x-koha-embed)","type":["string","null"]},"ill_backend_id":{"description":"The ILL backend identifier string","type":"string"},"ill_backend_request_id":{"description":"Backend-specific request id","type":["string","null"]},"ill_batch":{"description":"The linked ill batch object (x-koha-embed)","type":["object","null"]},"ill_batch_id":{"description":"Batch id this requests belongs to","type":["integer","null"]},"ill_request_id":{"description":"Internal ILL request identifier","type":"integer"},"library":{"description":"The linked library object (x-koha-embed)","type":["object","null"]},"library_id":{"description":"Internal library identifier","type":"string"},"medium":{"description":"Description of the ILL item medium","type":["string","null"]},"opac_notes":{"description":"Note that is visible to the patron","type":["string","null"]},"paid_price":{"description":"Effective request cost","type":["string","null"]},"patron":{"description":"The linked patron object (x-koha-embed)","type":["object","null"]},"patron_id":{"description":"Internal patron id","type":["integer","null"]},"replied_date":{"description":"FIXME","format":"date","type":["string","null"]},"requested_date":{"description":"Date the request was placed by the patron","format":"date","type":["string","null"]},"staff_notes":{"description":"Interal staff note about the request","type":["string","null"]},"status":{"description":"The status the request is at.\n\nNote: This is defined by each backend. Please refer to the specific backend's\ndocumentation or code to understand the possible values.\n","type":"string"},"status_av":{"description":"The authorised value category the field is linked to","type":["string","null"]},"timestamp":{"description":"Date and time of last object update","format":"date-time","type":"string"}},"type":"object"}

ill_status

{"$ref":"#\/definitions\/ill_status_yaml"}

ill_status_yaml

{"additionalProperties":false,"properties":{"backend":{"description":"The backend in which this status is used","type":"string"},"category":{"description":"The AV category in which the status aliases exists in","type":"string"},"code":{"description":"Internal ILL status code or av code","type":"string"},"str":{"description":"Internal ILL status display string","type":"string"},"type":{"description":"This is 'ill_status' or 'av' depending on if coming from backend or authorised values i.e. alias","type":"string"}},"type":"object"}

import_batch_profile

{"$ref":"#\/definitions\/import_batch_profile_yaml"}

import_batch_profile_yaml

{"additionalProperties":false,"properties":{"comments":{"description":"any comments added when the file was uploaded","type":["string","null"]},"encoding":{"description":"file encoding","type":["string","null"]},"format":{"description":"marc format","type":["string","null"]},"item_action":{"description":"what to do with item records","type":["string","null"]},"matcher_id":{"description":"the id of the match rule used (matchpoints.matcher_id)","type":["integer","null"]},"name":{"description":"name of this profile","type":"string"},"nomatch_action":{"description":"how to handle records where no match is found","type":["string","null"]},"overlay_action":{"description":"how to handle duplicate records","type":["string","null"]},"parse_items":{"description":"should items be parsed","type":["boolean","null"]},"profile_id":{"description":"Internal profile identifier","type":"integer"},"record_type":{"description":"type of record in the batch","type":["string","null"]},"template_id":{"description":"the id of the marc modification template","type":["integer","null"]}},"type":"object"}

import_batch_profiles

{"$ref":"#\/definitions\/import_batch_profiles_yaml"}

import_batch_profiles_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/import_batch_profile_yaml"},"type":"array"}

import_record_match

{"$ref":"#\/definitions\/import_record_match_yaml"}

import_record_match_yaml

{"additionalProperties":false,"properties":{"candidate_match_id":{"description":"Internal import record match candidate identifier","type":"integer"},"chosen":{"description":"Whether match has been chosen for overlay","type":"boolean"},"import_record_id":{"description":"Internal import record identifier","type":"integer"},"score":{"description":"Ranking value for this match calculated by the matching rules","type":"integer"}},"type":"object"}

invoice

{"$ref":"#\/definitions\/invoice_yaml"}

invoice_yaml

{"additionalProperties":false,"properties":{"close_date":{"description":"Invoice close date (only when the invoice is closed)","format":"date","type":"string"},"closed":{"description":"If the invoice is closed","type":"boolean"},"invoice_date":{"description":"Date of billing","format":"date","type":["string","null"]},"invoice_id":{"description":"Internal identifier for the incoide. Generated on POST","type":"integer"},"invoice_number":{"description":"Invoice number assigned by the vendor","type":"string"},"shipping_cost":{"description":"Shipping cost","type":["integer","null"]},"shipping_cost_budget_id":{"description":"Shipping cost linking to budget","type":["integer","null"]},"shipping_date":{"description":"Date of shipping","format":"date","type":["string","null"]},"vendor_id":{"description":"Internal identifier for the vendor","type":"integer"}},"type":"object"}

item

{"$ref":"#\/definitions\/item_yaml"}

item_group

{"$ref":"#\/definitions\/item_group_yaml"}

item_group_yaml

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal identifier for the parent bibliographic record","readOnly":true,"type":"integer"},"creation_date":{"description":"Date and time the item group was created","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Item group description","type":"string"},"display_order":{"description":"Item group description","type":"integer"},"item_group_id":{"description":"Internal identifier for the item group","readOnly":true,"type":"integer"},"items":{"description":"A list of items that belong to the volume (x-koha-embed)","readOnly":true,"type":["array","null"]},"modification_date":{"description":"Date and time the item group was last modified","format":"date-time","readOnly":true,"type":"string"}},"required":["item_group_id","biblio_id"],"type":"object"}

item_type

{"$ref":"#\/definitions\/item_type_yaml"}

item_type_translated_description_yaml

{"additionalProperties":false,"properties":{"lang":{"description":"Language identifier","type":"string"},"translation":{"description":"Translated plain text","type":"string"}},"required":["lang","translation"],"type":"object"}

item_type_yaml

{"additionalProperties":false,"properties":{"automatic_checkin":{"description":"Controls if automatic checkin is enabled for items of this type","type":"boolean"},"checkin_message":{"description":"Message that is displayed when an item with the given item type is checked in","type":["string","null"]},"checkin_message_type":{"description":"Type (CSS class) for the checkin_message, can be 'alert' or 'message'","type":["string","null"]},"daily_rental_charge":{"description":"The amount charged for each day between checkout date and due date","type":["number","null"]},"daily_rental_charge_calendar":{"description":"Controls if the daily rental fee is calculated directly or using finesCalendar","type":"boolean"},"default_replacement_cost":{"description":"Default replacement cost","type":["number","null"]},"description":{"description":"A plain text explanation of the item type","type":"string"},"hide_in_opac":{"description":"Hide the item type from the search options in OPAC","type":"boolean"},"hourly_rental_charge":{"description":"The amount charged for each hour between checkout date and due date","type":["number","null"]},"hourly_rental_charge_calendar":{"description":"Controls if the hourly rental fee is calculated directly or using finesCalendar","type":"boolean"},"image_url":{"description":"URL for the item type icon","type":["string","null"]},"item_type_id":{"description":"Unique key, a code associated with the item type","readOnly":true,"type":"string"},"not_for_loan_status":{"description":"If items of this type are not for loan","type":"boolean"},"parent_type":{"description":"Unique key, a code associated with the parent item type","type":["string","null"]},"process_fee":{"description":"Default text be recorded in the column note when the processing fee is applied","type":["number","null"]},"rentalcharge":{"description":"The amount charged when this item is checked out\/issued","type":["number","null"]},"searchcategory":{"description":"Group this item type with others with the same value on OPAC search options","type":["string","null"]},"sip_media_type":{"description":"SIP2 protocol media type for this item type","type":["string","null"]},"summary":{"description":"Information from the summary field, may include HTML","type":["string","null"]},"translated_descriptions":{"description":"Translations of description plain text (x-koha-embed)","items":{"$ref":"#\/definitions\/item_type_translated_description_yaml"},"type":"array"}},"required":["item_type_id"],"type":"object"}

item_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"A return claims object if one exists that's unresolved","type":["object","null"]},"acquisition_date":{"description":"The date the item was acquired","format":"date","type":["string","null"]},"acquisition_source":{"description":"Information about the acquisition source (it is not really a vendor id)","type":["string","null"]},"biblio":{},"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"bookable":{"description":"Allow bookings on this item.","type":"boolean"},"call_number_sort":{"description":"?","type":["string","null"]},"call_number_source":{"description":"Classification source used on this item","type":["string","null"]},"callnumber":{"description":"Call number for this item","type":["string","null"]},"checked_out_date":{"description":"Defines if item is checked out (NULL for not checked out, and checkout date for checked out)","format":"date","type":["string","null"]},"checkouts_count":{"description":"Number of times this item has been checked out\/issued","type":["integer","null"]},"coded_location_qualifier":{"description":"Coded location qualifier","type":["string","null"]},"collection_code":{"description":"Authorized value for the collection code associated with this item","type":["string","null"]},"copy_number":{"description":"Copy number","type":["string","null"]},"damaged_date":{"description":"The date and time an item was last marked as damaged, NULL if not damaged","type":["string","null"]},"damaged_status":{"description":"Authorized value defining this item as damaged","type":"integer"},"effective_item_type_id":{"description":"Effective itemtype defining the type for this item_id","type":["string","null"]},"effective_not_for_loan_status":{"description":"Authorized value defining why this item is not for not_for_loan_status","type":"integer"},"exclude_from_local_holds_priority":{"description":"Exclude this item from local holds priority.","type":"boolean"},"extended_subfields":{"description":"Additional 952 subfields in XML format","type":["string","null"]},"external_id":{"description":"The item's barcode","type":["string","null"]},"holding_library_id":{"description":"Library that is currently in possession item","type":["string","null"]},"holds_count":{"description":"Number of times this item has been placed on hold\/reserved","type":["integer","null"]},"home_library_id":{"description":"Internal library id for the library the item belongs to","type":["string","null"]},"internal_notes":{"description":"Non-public notes on this item","type":["string","null"]},"inventory_number":{"description":"Inventory number","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":"integer"},"item_type_id":{"description":"Itemtype defining the type for this item","type":["string","null"]},"last_checkout_date":{"description":"The date the item was last checked out","format":"date","type":["string","null"]},"last_seen_date":{"description":"The date the item barcode was last scanned","format":"date-time","type":["string","null"]},"location":{"description":"Authorized value for the shelving location for this item","type":["string","null"]},"lost_date":{"description":"The date and time an item was last marked as lost, NULL if not lost","format":"date-time","type":["string","null"]},"lost_status":{"description":"Authorized value defining this item as lost","type":"integer"},"materials_notes":{"description":"Materials specified","type":["string","null"]},"new_status":{"description":"'new' value, whatever free-text information.","type":["string","null"]},"not_for_loan_status":{"description":"Authorized value defining why this item is not for loan","type":"integer"},"permanent_location":{"description":"Linked to the CART and PROC temporary locations feature, stores the permanent shelving location","type":["string","null"]},"public_notes":{"description":"Public notes on this item","type":["string","null"]},"purchase_price":{"description":"Purchase price","type":["number","null"]},"renewals_count":{"description":"Number of times this item has been renewed","type":["integer","null"]},"replacement_price":{"description":"Cost the library charges to replace the item (e.g. if lost)","type":["number","null"]},"replacement_price_date":{"description":"The date the replacement price is effective from","format":"date","type":["string","null"]},"restricted_status":{"description":"Authorized value defining use restrictions for this item","type":["integer","null"]},"return_claim":{"type":["object","null"]},"return_claims":{"description":"An array of all return claims associated with this item","type":"array"},"serial_issue_number":{"description":"serial enumeration\/chronology for the item","type":["string","null"]},"timestamp":{"description":"Date and time this item was last altered","format":"date-time","type":"string"},"uri":{"description":"URL for the item","type":["string","null"]},"withdrawn":{"description":"Authorized value defining this item as withdrawn","type":"integer"},"withdrawn_date":{"description":"The date and time an item was last marked as withdrawn, NULL if not withdrawn","format":"date-time","type":["string","null"]}},"type":"object"}

job

{"$ref":"#\/definitions\/job_yaml"}

job_yaml

{"additionalProperties":false,"properties":{"context":{"description":"job context","type":"object"},"data":{"description":"job data","type":"object"},"ended_date":{"description":"job end date","format":"date-time","type":["string","null"]},"enqueued_date":{"description":"job enqueue date","format":"date-time","type":"string"},"job_id":{"description":"internally assigned job identifier","readOnly":true,"type":"integer"},"patron_id":{"description":"job enqueuer","type":["string","null"]},"progress":{"description":"job progress","type":["string","null"]},"queue":{"description":"job queue","type":"string"},"size":{"description":"job size","type":["string","null"]},"started_date":{"description":"job start date","format":"date-time","type":["string","null"]},"status":{"description":"job status","type":"string"},"type":{"description":"job type","type":"string"}},"type":"object"}

library

{"$ref":"#\/definitions\/library_yaml"}

library_yaml

{"additionalProperties":false,"properties":{"address1":{"description":"the first address line of the library","type":["string","null"]},"address2":{"description":"the second address line of the library","type":["string","null"]},"address3":{"description":"the third address line of the library","type":["string","null"]},"cash_registers":{"description":"The library's defined cash registers (x-koha-embed)","type":["array","null"]},"city":{"description":"the city or province of the library","type":["string","null"]},"country":{"description":"the county of the library","type":["string","null"]},"desks":{"description":"The library's defined desks (x-koha-embed)","type":["array","null"]},"email":{"description":"the primary email address of the library","type":["string","null"]},"fax":{"description":"the fax number of the library","type":["string","null"]},"geolocation":{"description":"geolocation of your library","type":["string","null"]},"illemail":{"description":"the ILL staff email address of the library","type":["string","null"]},"ip":{"description":"the IP address for your library or branch","type":["string","null"]},"library_id":{"description":"internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"marc_org_code":{"description":"MARC Organization Code, see http:\/\/www.loc.gov\/marc\/organizations\/orgshome.html, when empty defaults to syspref MARCOrgCode","type":["string","null"]},"name":{"description":"Printable name of library","type":"string"},"needs_override":{"description":"If the library needs an override to act as pickup location for a hold","type":"boolean"},"notes":{"description":"notes related to your library or branch","type":["string","null"]},"phone":{"description":"the primary phone of the library","type":["string","null"]},"pickup_location":{"description":"If the library can act as a pickup location","type":"boolean"},"postal_code":{"description":"the postal code of the library","type":["string","null"]},"public":{"description":"If the library is visible to the public","type":"boolean"},"reply_to_email":{"description":"the email to be used as a Reply-To","type":["string","null"]},"return_path_email":{"description":"the email to be used as Return-Path","type":["string","null"]},"smtp_server":{"description":"The library effective SMTP server","type":["object","null"]},"state":{"description":"the reqional state of the library","type":["string","null"]},"url":{"description":"the URL for your library or branch's website","type":["string","null"]}},"required":["library_id","name"],"type":"object"}

merge_biblios

{"$ref":"#\/definitions\/merge_biblios_yaml"}

merge_biblios_yaml

{"additionalProperties":false,"properties":{"biblio_id_to_merge":{"description":"Biblionumber from which to merge","type":"integer"},"datarecord":{"description":"Bibliographic record used as result of the merge. It uses the format MARC-in-JSON","type":["object","null"]},"framework_to_use":{"description":"Framework code, you can use it only with a value in datarecord field. With null value it uses the framework code of record to be merged into.","type":["string","null"]},"rules":{"description":"Internally identifier of a merge algoritm. Now two identifier are supported, 'override' and 'override_ext'. 'override' is to use when you the bibliographic data of biblio_id as resulting bibliographic data. The null value is equivalent of 'override'. 'override_ext' is to use only with a value in datarecord field. In fact is mandatory to use if you insert a record inside datarecord field.","type":["string","null"]}},"required":["biblio_id_to_merge"],"type":"object"}

order

{"$ref":"#\/definitions\/order_yaml"}

order_yaml

{"additionalProperties":false,"properties":{"basket":{"type":["object","null"]},"basket_id":{"description":"Basket this order is linked to","type":["integer","null"]},"biblio":{"type":["object","null"]},"biblio_id":{"description":"Identifier for the linked bibliographic record","type":["integer","null"]},"cancellation_date":{"description":"Date the line item was deleted","format":"date","type":["string","null"]},"cancellation_reason":{"description":"Reason of cancellation","type":["string","null"]},"claims_count":{"description":"Generated claim letters count","type":"integer"},"created_by":{"description":"Interal patron identifier of the order line creator","type":["integer","null"]},"creator":{"description":"Patron that created the order","type":["object","null"]},"currency":{"description":"Currency used for the purchase","type":["string","null"]},"current_item_level_holds_count":{"description":"Current holds count for associated items","type":"integer"},"date_received":{"description":"Date the order was received","format":"date","type":["string","null"]},"deleted_biblio_id":{"description":"Identifier for the linked deleted bibliographic record","type":["integer","null"]},"discount_rate":{"description":"Discount rate","type":["number","null"]},"ecost":{"description":"Effective cost","type":["number","null"]},"ecost_tax_excluded":{"description":"Effective cost (tax excluded)","type":["number","null"]},"ecost_tax_included":{"description":"Effective cost (tax included)","type":["number","null"]},"entry_date":{"description":"Date the bib was added to the basket","format":"date","type":["string","null"]},"estimated_delivery_date":{"description":"Estimated delivery date","format":"date","type":["string","null"]},"fund":{"type":["object","null"]},"fund_id":{"description":"Internal identifier for the fund this order goes against","type":"integer"},"internal_note":{"description":"Notes related to this order line, made for staff","type":["string","null"]},"invoice":{"type":["object","null"]},"invoice_currency":{"description":"Currency of the actual cost used when receiving","type":["string","null"]},"invoice_id":{"description":"Id of the order invoice","type":["integer","null"]},"invoice_unit_price":{"description":"The actual cost in the foreign currency used in the invoice","type":["number","null"]},"items":{"type":"array"},"last_claim_date":{"description":"Last date a claim letter was generated","format":"date","type":["string","null"]},"list_price":{"description":"Vendor price for the line item","type":["number","null"]},"order_id":{"description":"Internally assigned order identifier","type":"integer"},"parent_order_id":{"description":"Order ID of parent order line if exists","type":["integer","null"]},"quantity":{"description":"Ordered quantity","type":["integer","null"]},"quantity_received":{"description":"Quantity received so far","type":"integer"},"replacement_price":{"description":"Replacement cost for this item","type":["number","null"]},"rrp":{"description":"Retail cost for this item","type":["number","null"]},"rrp_tax_excluded":{"description":"Replacement cost for this item (tax excluded)","type":["number","null"]},"rrp_tax_included":{"description":"Replacement cost for this item (tax included)","type":["number","null"]},"shipping_cost":{"description":"Shipping cost","type":["number","null"]},"statistics_1":{"description":"Statistical field","type":["string","null"]},"statistics_1_authcat":{"description":"Statistical category for this order","type":["string","null"]},"statistics_2":{"description":"Statistical field (2)","type":["string","null"]},"statistics_2_authcat":{"description":"Statistical category for this order (2)","type":["string","null"]},"status":{"description":"The current order status","enum":["new","ordered","partial","complete","cancelled"],"type":"string"},"subscription":{"type":["object","null"]},"subscription_id":{"description":"Subscription ID linking the order to a subscription","type":["integer","null"]},"tax_rate_on_ordering":{"description":"Tax rate on ordering (%)","type":["number","null"]},"tax_rate_on_receiving":{"description":"Tax rate on receiving (%)","type":["number","null"]},"tax_value_on_ordering":{"description":"Tax value on ordering","type":["number","null"]},"tax_value_on_receiving":{"description":"Tax value on receiving","type":["number","null"]},"timestamp":{"description":"Date and time this order line was last modified","format":"date-time","type":"string"},"uncertain_price":{"description":"If this price was uncertain","type":"boolean"},"unit_price":{"description":"The actual cost entered when receiving this line item","type":["number","null"]},"unit_price_tax_excluded":{"description":"Unit price excluding tax (on receiving)","type":["number","null"]},"unit_price_tax_included":{"description":"Unit price including tax (on receiving)","type":["number","null"]},"vendor_note":{"description":"Notes related to this order line, made for vendor","type":["string","null"]}},"type":"object"}

patron

{"$ref":"#\/definitions\/patron_yaml"}

patron_account_credit

{"$ref":"#\/definitions\/patron_account_credit_yaml"}

patron_account_credit_yaml

{"additionalProperties":false,"properties":{"account_lines_ids":{"description":"List of account line ids the credit goes against (optional)","items":{"type":"integer"},"type":"array"},"amount":{"description":"Credit amount","minimum":0,"type":"number"},"credit_type":{"description":"Type of credit ('CREDIT', 'FORGIVEN', 'LOST_FOUND', 'PAYMENT', 'WRITEOFF', 'PROCESSING_FOUND' )","type":"string"},"date":{"description":"Date the credit was recorded (optional)","format":"date","type":"string"},"description":{"description":"Description","type":"string"},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"note":{"description":"Internal note","type":"string"},"payment_type":{"description":"Payment type (only applies when credit_type=payment)","type":"string"}},"required":["amount"],"type":"object"}

patron_balance

{"$ref":"#\/definitions\/patron_balance_yaml"}

patron_balance_yaml

{"additionalProperties":false,"properties":{"balance":{"description":"Signed decimal number","type":"number"},"outstanding_credits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line_yaml"},"type":"array"},"total":{"type":"number"}}},"outstanding_debits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line_yaml"},"type":"array"},"total":{"type":"number"}},"type":"object"}},"required":["balance"],"type":"object"}

patron_category

{"$ref":"#\/definitions\/patron_category_yaml"}

patron_category_yaml

{"additionalProperties":false,"properties":{"block_expired_patron_opac_actions":{"description":"Whether or not a patron of this category can renew books or place holds once their card has expired. 0 means they can, 1 means they cannot, -1 means use syspref BlockExpiredPatronOpacActions","type":"number"},"can_be_guarantee":{"description":"If patrons of this category can be guarantees","type":"boolean"},"can_place_ill_in_opac":{"description":"Can this patron category place interlibrary loan requests","type":"boolean"},"category_type":{"description":"Type of Koha patron (Adult, Child, Professional, Organizational, Statistical, Staff)","type":"string"},"change_password":{"description":"If patrons of this category can change their passwords in the OPAC","type":["boolean","null"]},"check_prev_checkout":{"description":"Produce a warning for this patron category if this item has previously been checked out to this patron if ''yes'', not if ''no'', defer to syspref setting if ''inherit''.'","type":"string"},"default_privacy":{"description":"Default privacy setting for this patron category","enum":["default","never","forever"],"type":"string"},"enrolment_fee":{"description":"Enrollment fee for the patron","type":["number","null"]},"enrolment_period":{"description":"Number of months the patron is enrolled for","type":["number","null"]},"enrolment_period_date":{"description":"Date the patron is enrolled until","format":"date","type":["string","null"]},"exclude_from_local_holds_priority":{"description":"Exclude patrons of this category from local holds priority","type":["boolean","null"]},"hide_lost_items":{"description":"Are lost items shown to this category (1 for yes, 0 for no)","type":"boolean"},"lower_age_limit":{"description":"The minimum age required for the patron category","type":["number","null"]},"min_password_length":{"description":"Set minimum password length for patrons in this category","type":["number","null"]},"name":{"description":"Name of the patron category","type":["string","null"]},"overdue_notice_required":{"description":"Are overdue notices sent to this patron category (1 for yes, 0 for no)","type":["boolean","null"]},"password_expiry_days":{"description":"Number of days after which the patron must reset their password","type":["number","null"]},"patron_category_id":{"description":"Internal patron category identifier","type":"string"},"require_strong_password":{"description":"Set required password strength for patrons in this category","type":["boolean","null"]},"reserve_fee":{"description":"Cost to place holds","type":["number","null"]},"reset_password":{"description":"If patrons of this category can do the password reset flow","type":["boolean","null"]},"upper_age_limit":{"description":"Age limit for the patron","type":["number","null"]}},"required":["patron_category_id"],"type":"object"}

patron_extended_attribute

{"$ref":"#\/definitions\/patron_extended_attribute_yaml"}

patron_extended_attribute_yaml

{"additionalProperties":false,"properties":{"extended_attribute_id":{"description":"Internal ID for the extended attribute","type":"integer"},"type":{"description":"Extended attribute type","type":"string"},"value":{"description":"Extended attribute value","type":["string","null"]}},"required":["type","value"],"type":"object"}

patron_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"account_balance":{"description":"Balance of the patron's account","type":["number","null"]},"address":{"description":"first address line of patron's primary address","type":["string","null"]},"address2":{"description":"second address line of patron's primary address","type":["string","null"]},"altaddress_address":{"description":"first address line of patron's alternate address","type":["string","null"]},"altaddress_address2":{"description":"second address line of patron's alternate address","type":["string","null"]},"altaddress_city":{"description":"city or town of patron's alternate address","type":["string","null"]},"altaddress_country":{"description":"country of patron's alternate address","type":["string","null"]},"altaddress_email":{"description":"email address for patron's alternate address","type":["string","null"]},"altaddress_notes":{"description":"a note related to patron's alternate address","type":["string","null"]},"altaddress_phone":{"description":"phone number for patron's alternate address","type":["string","null"]},"altaddress_postal_code":{"description":"zip or postal code of patron's alternate address","type":["string","null"]},"altaddress_state":{"description":"state or province of patron's alternate address","type":["string","null"]},"altaddress_street_number":{"description":"street number of patron's alternate address","type":["string","null"]},"altaddress_street_type":{"description":"street type of patron's alternate address","type":["string","null"]},"altcontact_address":{"description":"the first address line for the alternate contact for the patron","type":["string","null"]},"altcontact_address2":{"description":"the second address line for the alternate contact for the patron","type":["string","null"]},"altcontact_city":{"description":"the city for the alternate contact for the patron","type":["string","null"]},"altcontact_country":{"description":"the country for the alternate contact for the patron","type":["string","null"]},"altcontact_firstname":{"description":"first name of alternate contact for the patron","type":["string","null"]},"altcontact_phone":{"description":"the phone number for the alternate contact for the patron","type":["string","null"]},"altcontact_postal_code":{"description":"the zipcode for the alternate contact for the patron","type":["string","null"]},"altcontact_state":{"description":"the state for the alternate contact for the patron","type":["string","null"]},"altcontact_surname":{"description":"surname or last name of the alternate contact for the patron","type":["string","null"]},"anonymized":{"description":"If the patron has been anonymized","readOnly":true,"type":"boolean"},"autorenew_checkouts":{"description":"indicate whether auto-renewal is allowed for patron","type":"boolean"},"cardnumber":{"description":"library assigned user identifier","type":["string","null"]},"category_id":{"description":"Internal identifier for the patron's category","type":"string"},"check_previous_checkout":{"description":"produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'","type":"string"},"checkouts_count":{"description":"Number of checkouts","type":["integer","null"]},"city":{"description":"city or town of patron's primary address","type":["string","null"]},"country":{"description":"country of patron's primary address","type":["string","null"]},"date_enrolled":{"description":"date the patron was added to Koha","format":"date","type":["string","null"]},"date_of_birth":{"description":"patron's date of birth","format":"date","type":["string","null"]},"date_renewed":{"description":"date the patron's card was last renewed","format":"date","type":["string","null"]},"email":{"description":"primary email address for patron's primary address","type":["string","null"]},"expiry_date":{"description":"date the patron's card is set to expire","format":"date","type":["string","null"]},"extended_attributes":{"description":"patron's extended attributes","items":{"$ref":"#\/definitions\/patron_extended_attribute_yaml"},"type":"array"},"fax":{"description":"fax number for patron's primary address","type":["string","null"]},"firstname":{"description":"patron's first name","type":["string","null"]},"gender":{"description":"patron's gender","type":["string","null"]},"incorrect_address":{"description":"set to 1 if library marked this patron as having an unconfirmed address","type":["boolean","null"]},"initials":{"description":"initials of the patron","type":["string","null"]},"lang":{"description":"lang to use to send notices to this patron","type":"string"},"last_seen":{"description":"last time a patron has been seen (connected at the OPAC or staff interface)","format":"date-time","type":["string","null"]},"library":{"description":"Library of the patron","type":["object","null"]},"library_id":{"description":"Internal identifier for the patron's home library","type":"string"},"login_attempts":{"description":"number of failed login attemps","type":["integer","null"]},"middle_name":{"description":"patron's middle name","type":["string","null"]},"mobile":{"description":"the other phone number for patron's primary address","type":["string","null"]},"opac_notes":{"description":"a note on the patron's account visible in OPAC and staff interface","type":["string","null"]},"other_name":{"description":"any other names associated with the patron","type":["string","null"]},"overdrive_auth_token":{"description":"persist OverDrive auth token","type":["string","null"]},"overdues_count":{"description":"Number of overdued checkouts","type":["integer","null"]},"patron_card_lost":{"description":"set to 1 if library marked this patron as having lost his card","type":["boolean","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"phone":{"description":"primary phone number for patron's primary address","type":["string","null"]},"postal_code":{"description":"zip or postal code of patron's primary address","type":["string","null"]},"privacy":{"description":"patron's privacy settings related to their checkout history","type":"integer"},"privacy_guarantor_checkouts":{"description":"controls if relatives can see this patron's checkouts","type":"integer"},"privacy_guarantor_fines":{"description":"controls if relatives can see this patron's fines","type":"boolean"},"pronouns":{"description":"pronouns of the patron","type":["string","null"]},"protected":{"description":"Protected status of the patron","type":["boolean"]},"relationship_type":{"description":"used for children to include the relationship to their guarantor","type":["string","null"]},"restricted":{"description":"If any restriction applies to the patron","readOnly":true,"type":"boolean"},"secondary_email":{"description":"secondary email address for patron's primary address","type":["string","null"]},"secondary_phone":{"description":"secondary phone number for patron's primary address","type":["string","null"]},"sms_number":{"description":"the mobile phone number where the patron would like to receive notices (if SMS turned on)","type":["string","null"]},"sms_provider_id":{"description":"the provider of the mobile phone number defined in smsalertnumber","type":["integer","null"]},"staff_notes":{"description":"a note on the patron's account","type":["string","null"]},"state":{"description":"state or province of patron's primary address","type":["string","null"]},"statistics_1":{"description":"a field that can be used for any information unique to the library","type":["string","null"]},"statistics_2":{"description":"a field that can be used for any information unique to the library","type":["string","null"]},"street_number":{"description":"street number of patron's primary address","type":["string","null"]},"street_type":{"description":"street type of patron's primary address","type":["string","null"]},"surname":{"description":"patron's last name","type":["string","null"]},"title":{"description":"patron's title","type":["string","null"]},"updated_on":{"description":"time of last change could be useful for synchronization with external systems (among others)","format":"date-time","type":"string"},"userid":{"description":"patron's login","type":["string","null"]}},"required":["surname","library_id","category_id"],"type":"object"}

preservation_config

{"$ref":"#\/definitions\/preservation_config_yaml"}

preservation_config_yaml

{"additionalProperties":false,"properties":{"permissions":{"description":"List of permissions of the logged in user used for the Preservation module","type":"object"},"settings":{"description":"List of sysprefs used for the Preservation module","type":"object"}},"type":"object"}

preservation_processing

{"$ref":"#\/definitions\/preservation_processing_yaml"}

preservation_processing_attribute_yaml

{"additionalProperties":false,"properties":{"name":{"type":"string"},"option_source":{"type":["string","null"]},"processing_attribute_id":{"description":"Internal processing attribute identifier","type":"integer"},"processing_id":{"description":"Internal processing identifier","type":"integer"},"type":{"type":["string"]}},"required":["name","type"],"type":"object"}

preservation_processing_yaml

{"additionalProperties":false,"properties":{"attributes":{"description":"attributes of the processing","items":{"$ref":"#\/definitions\/preservation_processing_attribute_yaml"}},"letter_code":{"description":"Letter code of the letter to use for printing slips","type":["string","null"]},"name":{"description":"name of the processing","type":"string"},"processing_id":{"description":"internally assigned agreement identifier","readOnly":true,"type":"integer"}},"required":["processing_id","name"],"type":"object"}

preservation_train

{"$ref":"#\/definitions\/preservation_train_yaml"}

preservation_train_item

{"$ref":"#\/definitions\/preservation_train_item_yaml"}

preservation_train_item_yaml

{"additionalProperties":false,"properties":{"added_on":{"description":"add date","type":["string","null"]},"attributes":{"description":"attribute list","type":["array","null"]},"catalogue_item":{"description":"catalogue item","type":["object","null"]},"item_id":{"description":"internally item identifier","type":"integer"},"processing_id":{"description":"internally processing identifier","type":"integer"},"train_id":{"description":"internally train identifier","type":"integer"},"train_item_id":{"description":"internally assigned train item identifier","readOnly":true,"type":"integer"},"user_train_item_id":{"description":"internally user train item identifier","type":"integer"}},"type":"object"}

preservation_train_yaml

{"additionalProperties":false,"properties":{"closed_on":{"description":"closing date","type":["string","null"]},"created_on":{"description":"creation date","type":["string","null"]},"default_processing":{"description":"the default processing","type":["object","null"]},"default_processing_id":{"description":"foreign key to preservation_processings","type":["integer","null"]},"description":{"description":"description of the train","type":["string","null"]},"name":{"description":"name of the train","type":"string"},"not_for_loan":{"description":"NOT_LOAN authorised value to apply to item added to this train","type":["string","null"]},"received_on":{"description":"receiving date","type":["string","null"]},"sent_on":{"description":"sending date","type":["string","null"]},"train_id":{"description":"internally assigned train identifier","readOnly":true,"type":"integer"}},"required":["train_id","name"],"type":"object"}

quote

{"$ref":"#\/definitions\/quote_yaml"}

quote_yaml

{"additionalProperties":false,"properties":{"displayed_on":{"description":"Last display date","type":["string","null"]},"quote_id":{"description":"internally assigned quote identifier","type":"integer"},"source":{"description":"source of the quote","type":"string"},"text":{"description":"text","type":["string","null"]}},"required":["source","text"],"type":"object"}

recall

{"$ref":"#\/definitions\/recall_yaml"}

recall_yaml

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"completed":{"description":"Controls if the recall is fulfilled","type":"boolean"},"completed_date":{"description":"The date the recall was fulfilled","format":"date-time","type":["string","null"]},"created_date":{"description":"The date the recall was requested","format":"date-time","type":["string","null"]},"expiration_date":{"description":"The date the recall expires","format":"date-time","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["integer","null"]},"item_level":{"description":"If the recall is requested at item level","type":"boolean"},"notes":{"description":"Notes related to this recall","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":["string","null"]},"priority":{"description":"Where in the queue the patron sits (not yet implemented)","type":["integer","null"]},"recall_id":{"description":"Internal recall identifier","type":"integer"},"status":{"description":"Status of the recall","enum":["requested","overdue","waiting","in_transit","cancelled","expired","fulfilled"],"type":"string"},"timestamp":{"description":"Timestamp for the latest recall update","format":"date-time","type":"string"},"waiting_date":{"description":"The date the item was marked as waiting for the patron at the library","format":"date-time","type":["string","null"]}},"type":"object"}

recalls

{"$ref":"#\/definitions\/recalls_yaml"}

recalls_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/recall_yaml"},"type":"array"}

renewal

{"$ref":"#\/definitions\/renewal_yaml"}

renewal_yaml

{"additionalProperties":false,"properties":{"checkout_id":{"description":"internally assigned checkout identifier","type":"integer"},"interface":{"description":"Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)","type":["string","null"]},"renewal_date":{"description":"Date the renewal took place","format":"date-time","type":"string"},"renewal_id":{"description":"internally assigned renewal identifier","type":"integer"},"renewal_type":{"enum":["Automatic","Manual"],"type":["string","null"]},"renewer":{"description":"The object representing the renewal issuer","type":["object","null"]},"renewer_id":{"description":"internally assigned for the user that processed the renewal","type":["integer","null"]},"seen":{"description":"Seen\/Unseen renewal","type":["boolean"]},"timestamp":{"description":"Last update time","type":"string"}},"type":"object"}

renewals

{"$ref":"#\/definitions\/renewals_yaml"}

renewals_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/renewal_yaml"},"type":"array"}

return_claim

{"$ref":"#\/definitions\/return_claim_yaml"}

return_claim_yaml

{"additionalProperties":false,"properties":{"claim_id":{"description":"internally assigned return claim identifier","type":["integer"]},"created_by":{"description":"patron id of librarian who made the claim","type":["integer","null"]},"created_on":{"description":"date of claim creation","format":"date-time","type":["string","null"]},"issue_id":{"description":"internal identifier of the claimed checkout if still checked out","type":["integer","null"]},"item_id":{"description":"internal identifier of the claimed item","type":["integer"]},"notes":{"description":"notes about this claim","type":["string","null"]},"old_issue_id":{"description":"internal identifier of the claimed checkout if not longer checked out","type":["integer","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"resolution":{"description":"code of resolution type for this claim","type":["string","null"]},"resolved_by":{"description":"patron id of librarian who resolved this claim","type":["integer","null"]},"resolved_on":{"description":"date the claim was resolved","format":"date-time","type":["string","null"]},"updated_by":{"description":"patron id of librarian who last updated the claim","type":["integer","null"]},"updated_on":{"description":"date the claim was last updated","format":"date-time","type":["string","null"]}},"type":"object"}

{"$ref":"#\/definitions\/search_filter_yaml"}

search_filter_yaml

{"additionalProperties":false,"properties":{"limits":{"description":"filter limits part","type":["string","null"]},"name":{"description":"filter name","type":"string"},"opac":{"description":"visible on opac","type":["boolean","null"]},"query":{"description":"filter query part","type":["string","null"]},"search_filter_id":{"description":"internally assigned search filter identifier","readOnly":true,"type":"integer"},"staff_client":{"description":"visible in staff client","type":["boolean","null"]}},"required":["name"],"type":"object"}

smtp_server

{"$ref":"#\/definitions\/smtp_server_yaml"}

smtp_server_yaml

{"additionalProperties":false,"properties":{"debug":{"description":"If the SMTP connection is set to debug mode","type":"boolean"},"host":{"description":"SMTP host name","type":"string"},"is_default":{"description":"Is this the default SMTP server","type":"boolean"},"name":{"description":"Name of the SMTP server","type":"string"},"password":{"description":"The password to use for authentication (optional)","type":["string","null"]},"port":{"description":"TCP port number","type":"integer"},"smtp_server_id":{"description":"Internal SMTP server identifier","readOnly":true,"type":"integer"},"ssl_mode":{"description":"If SSL\/TLS will be used","enum":["disabled","ssl","starttls"],"type":"string"},"timeout":{"description":"Maximum time in seconds to wait for server","type":"integer"},"user_name":{"description":"The user name to use for authentication (optional)","type":["string","null"]}},"required":["name"],"type":"object"}

suggestion

{"$ref":"#\/definitions\/suggestion_yaml"}

suggestion_yaml

{"additionalProperties":false,"properties":{"accepted_by":{"description":"patron_id for the librarian who accepted the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"accepted_date":{"description":"date the suggestion was marked as accepted","format":"date","type":["string","null"]},"archived":{"description":"archived (processed) suggestion","type":["boolean","null"]},"author":{"description":"author of the suggested item","type":["string","null"]},"biblio_id":{"description":"foreign key linking the suggestion to the biblio table after the suggestion has been ordered","type":["integer","null"]},"budget_id":{"description":"foreign key linking the suggested budget to the aqbudgets table","type":["integer","null"]},"collection_title":{"description":"collection name for the suggested item","type":["string","null"]},"copyright_date":{"description":"copyright date of the suggested item","type":["integer","null"]},"currency":{"description":"suggested currency for the suggested price","type":["string","null"]},"isbn":{"description":"isbn of the suggested item","type":["string","null"]},"item_price":{"description":"suggested price","type":["number","null"]},"item_type":{"description":"suggested item type","type":["string","null"]},"last_status_change_by":{"description":"patron the suggestion was last modified by","type":["integer","null"]},"last_status_change_date":{"description":"date the suggestion was last modified","format":"date","type":["string","null"]},"library_id":{"description":"foreign key linking the suggested branch to the branches table","type":["string","null"]},"managed_by":{"description":"patron_id for the librarian managing the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"managed_date":{"description":"date the suggestion was updated","format":"date","type":["string","null"]},"note":{"description":"note entered on the suggestion","type":["string","null"]},"patron_reason":{"description":"reason for making the suggestion","type":["string","null"]},"publication_place":{"description":"publication place of the suggested item","type":["string","null"]},"publication_year":{"description":"year of publication","type":["string","null"]},"publisher_code":{"description":"publisher of the suggested item","type":["string","null"]},"quantity":{"description":"suggested quantity to be purchased","type":["string","null"]},"reason":{"description":"reason for accepting or rejecting the suggestion","type":["string","null"]},"rejected_by":{"description":"patron_id for the librarian who rejected the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"rejected_date":{"description":"date the suggestion was marked as rejected","format":"date","type":["string","null"]},"staff_note":{"description":"non-public note entered on the suggestion","type":["string","null"]},"status":{"description":"Suggestion status. Possible values are:\n\n* `ASKED`\n* `CHECKED`\n* `ACCEPTED`\n* `REJECTED`\n* `ORDERED`\n* `AVAILABLE`\n* Values from the `SUGGEST_STATUS` av category\n","type":"string"},"suggested_by":{"description":"patron_id for the person making the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"suggestion_date":{"description":"the suggestion was submitted","format":"date","type":"string"},"suggestion_id":{"description":"unique identifier assigned automatically by Koha","readOnly":true,"type":"integer"},"timestamp":{"description":"timestamp of date created","format":"date-time","type":["string","null"]},"title":{"description":"title of the suggested item","type":["string","null"]},"total_price":{"description":"suggested total cost (price*quantity updated for currency)","type":["string","null"]},"volume_desc":{"description":"volume description","type":["string","null"]}},"type":"object"}

ticket

{"$ref":"#\/definitions\/ticket_yaml"}

ticket_update

{"$ref":"#\/definitions\/ticket_update_yaml"}

ticket_update_yaml

{"additionalProperties":true,"properties":{"date":{"description":"Date the ticket update was reported","format":"date-time","readOnly":true,"type":["string","null"]},"message":{"description":"Ticket update details","type":"string"},"public":{"description":"Is this update intended to be sent to the patron","type":"boolean"},"ticket_id":{"description":"Internal ticket identifier","readOnly":true,"type":"integer"},"update_id":{"description":"Internal ticket update identifier","readOnly":true,"type":"integer"},"user":{"description":"The object representing the patron who added the update","readOnly":true,"type":["object","null"]},"user_id":{"description":"Internal identifier for the patron who added the update","type":"integer"}},"required":["message","public"],"type":"object"}

ticket_yaml

{"additionalProperties":false,"properties":{"biblio":{"description":"The object representing the biblio the ticket is related to","readOnly":true,"type":["object","null"]},"biblio_id":{"description":"Internal identifier for the biblio the ticket is related to","type":"integer"},"body":{"description":"Ticket details","type":"string"},"reported_date":{"description":"Date the ticket was reported","format":"date-time","readOnly":true,"type":["string","null"]},"reporter":{"description":"The object representing the patron who reported the ticket","readOnly":true,"type":["object","null"]},"reporter_id":{"description":"Internal identifier for the patron who reported the ticket","type":"integer"},"resolved_date":{"description":"Date the ticket was resolved_date","format":"date-time","type":["string","null"]},"resolver":{"description":"The object representing the user who resolved the ticket","readOnly":true,"type":["object","null"]},"resolver_id":{"description":"Internal identifier for the user who resolved the ticket","type":["integer","null"]},"ticket_id":{"description":"Internal ticket identifier","readOnly":true,"type":"integer"},"title":{"description":"Ticket title","type":"string"},"updates_count":{"description":"Number of updates","type":["integer","null"]}},"required":["title","body"],"type":"object"}

transfer_limit

{"$ref":"#\/definitions\/transfer_limit_yaml"}

transfer_limit_yaml

{"additionalProperties":false,"properties":{"collection_code":{"description":"Authorized value for the collection code associated with this limit","type":["string","null"]},"from_library_id":{"description":"Internal library id for which library the item is coming from","type":"string"},"item_type":{"description":"Itemtype defining the type for this limi","type":["string","null"]},"limit_id":{"description":"Internal transfer limit identifier","type":"integer"},"to_library_id":{"description":"Internal library id for which library the item is going to","type":"string"}},"required":["to_library_id","from_library_id"],"type":"object"}

vendor

{"$ref":"#\/definitions\/vendor_yaml"}

vendor_alias_yaml

{"additionalProperties":false,"properties":{"alias":{"description":"The alias","type":"string"},"alias_id":{"description":"Internal ID for the extended attribute","type":"integer"},"vendor_id":{"description":"ID of the vendor","type":"integer"}},"required":["alias"],"type":"object"}

vendor_issue

{"$ref":"#\/definitions\/vendor_issue_yaml"}

vendor_issue_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"A list of stringified coded values","type":["object","null"]},"ended_on":{"description":"End date","format":"date","type":["string","null"]},"issue_id":{"description":"internally assigned vendor identifier","readOnly":true,"type":"integer"},"notes":{"description":"Notes","type":["string","null"]},"started_on":{"description":"Start date","format":"date","type":["string","null"]},"type":{"description":"Type of the issue","type":["string","null"]},"vendor_id":{"description":"ID of the vendor","type":"integer"}},"type":"object"}

vendor_yaml

{"additionalProperties":false,"properties":{"accountnumber":{"description":"Vendor account number","type":["string","null"]},"active":{"description":"Is this vendor active","type":["boolean","null"]},"address1":{"description":"Vendor physical address (line 1)","type":["string","null"]},"address2":{"description":"Vendor physical address (line 2)","type":["string","null"]},"address3":{"description":"Vendor physical address (line 3)","type":["string","null"]},"address4":{"description":"Vendor physical address (line 4)","type":["string","null"]},"aliases":{"description":"List of aliases","items":{"$ref":"#\/definitions\/vendor_alias_yaml"},"type":"array"},"deliverytime":{"description":"Expected delivery time (in days)","type":["integer","null"]},"discount":{"description":"Default discount rate for items ordered from this vendor","type":["number","null"]},"external_id":{"description":"External id","type":["string","null"]},"fax":{"description":"Vendor fax number","type":["string","null"]},"gst":{"description":"Is the library taxed when buying from this vendor","type":["boolean","null"]},"id":{"description":"internally assigned vendor identifier","readOnly":true,"type":"integer"},"invoice_currency":{"description":"Invoice prices currency","type":["string","null"]},"invoice_includes_gst":{"description":"Invoice prices include taxes","type":["boolean","null"]},"list_currency":{"description":"List prices currency","type":["string","null"]},"list_includes_gst":{"description":"List prices include taxes","type":["boolean","null"]},"name":{"description":"Vendor name","type":["string"]},"notes":{"description":"Vendor notes","type":["string","null"]},"phone":{"description":"Vendor phone number","type":["string","null"]},"postal":{"description":"Vendor postal address","type":["string","null"]},"tax_rate":{"description":"Default tax rate for items ordered from this vendor","type":["number","null"]},"type":{"description":"Type of vendor","type":["string","null"]},"url":{"description":"Vendor web address","type":["string","null"]}},"required":["name"],"type":"object"}