Koha REST API

Version 1 - OpenAPI 2.0

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.

License

GPL v3,

Contact information

https://koha-community.org/

Base URL

Resources

Two factor register

Generate a secret

Parameters

This resource has no input parameters.

Response 201

OK
{"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

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

OK
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

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

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

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

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

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 500

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

Response 501

Default response.
{"$ref":"#\/definitions\/DefaultResponse"}

Response 503

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 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 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 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

Batch add transfer limits

This resource batch creates new transfer limits based on the given data. 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

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"}

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
{"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"}

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

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

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

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

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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

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 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 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 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 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 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 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 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 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 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 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 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 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 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"}

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 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 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 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 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 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 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

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

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

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

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

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

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 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 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 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 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 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

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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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

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"}

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
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"}

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 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 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 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

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 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"}

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 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 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 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 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 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

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

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

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

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

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

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

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

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

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

Register 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"}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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"}

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

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

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

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

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
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 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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"}

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

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"}

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

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

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

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

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

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

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

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

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

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

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

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

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"}

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

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"}

loginOAuthClient

Login to OAuth provider

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"}

loginOAuthClientPublic

Login to OAuth provider

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"}

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

OK
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

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

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

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

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

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

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

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

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

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

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

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

Send OTP token for second step authentication

Parameters

This resource has no input parameters.

Response 200

OK
{"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

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

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

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

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

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

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

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

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

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

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

OK
{"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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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"}

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

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

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

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

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

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","readOnly":true,"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"}
{"$ref":"#\/definitions\/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"}

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"}

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":{