Koha REST API

Version 1 - OpenAPI 2.0

About

## Introduction This API is documented in **OpenAPI format**. ## 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. ## 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 * in a special header `x-koha-query` 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` wilth 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"}

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

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

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

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 authentication 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 authentication 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 authentication provider domain

Parameters

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

Body

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

Response 201

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

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

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

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

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

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

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-query header string No Query filter sent as a request 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
{"$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"}

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

delIdentityProvider

Delete authentication provider

Parameters

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

Response 204

Authentication 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 authentication provider

Parameters

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

Response 204

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

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

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

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

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

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

Response 500

Internal server error. Possible `error_code` 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"}

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

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

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

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

getBiblioItems

Get items 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-query header string No Query filter sent as a request header
x-koha-request-id header integer No Request id 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"}

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-query header string No Query filter 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
x-koha-query header string No Query filter sent as a request header

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

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

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-query header string No Query filter sent as a request header
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 authentication provider

Parameters

Name In Type Required Description
identity_provider_id path integer Yes Authentication provider internal identifier
x-koha-embed header array No Embed list sent as a request header

Response 200

An authentication 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 authentication provider domain

Parameters

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

Response 200

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

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

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

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
x-koha-request-id header integer No Request id 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"}

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

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
x-koha-query header string No Query filter sent as a request header

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
x-koha-query header string No Query filter sent as a request header

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

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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
x-koha-query header string No Query filter sent as a request header

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

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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
x-koha-query header string No Query filter 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"}

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
preceeding_publication_title_id query string No Case insensitive search on title preceeding_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
x-koha-query header string No Query filter sent as a request header

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
x-koha-request-id header integer No Request id 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 authentication provider configured domains

Parameters

Name In Type Required Description
identity_provider_id path integer Yes Authentication 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-query header string No Query filter sent as a request header
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 authentication 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 authentication 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-query header string No Query filter sent as a request header
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 authentication 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"}

listIllrequests

List ILL requests

Parameters

Name In Type Required Description
embed query array No Additional objects that should be embedded in the response
backend query string No The name of a ILL backend
orderid query string No The order ID of a request
biblionumber query integer No Internal biblio identifier
borrowernumber query integer No Internal patron identifier
completed query string No The date the request was considered completed
completed_formatted query string No The date the request was considered complete formatted
status query string No A full status string e.g. REQREV
cost query number No The quoted cost of the request
price_paid query number No The final cost of the request
medium query string No The medium of the requested item
updated query string No The last updated date of the request
updated_formatted query string No The last updated date of the request formatted
placed query string No The date the request was placed
placed_formatted query string No The date the request was placed formatted
branchcode query string No Library ID

Response 200

A list of ILL requests
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

ILL requests 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-query header string No Query filter sent as a request header
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
x-koha-query header string No Query filter sent as a request header

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

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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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"}

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
_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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
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"}

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-query header string No Query filter sent as a request header
x-koha-request-id header integer No Request id 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"}

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

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 500

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

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

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

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

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

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

Parameters

Name In Type Required Description
identity_provider_id path integer Yes Authentication 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 authentication 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 authentication provider domain

Parameters

Name In Type Required Description
identity_provider_id path integer Yes Authentication provider internal identifier
identity_provider_domain_id path integer Yes Authentication provider domain internal identifier
body body Yes An authentication provider domain object

Body

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

Response 200

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

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

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

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 username and password information

Body

{"additionalProperties":false,"properties":{"password":{"description":"Password (plain text)","type":"string"},"userid":{"description":"Username","type":"string"}},"required":["userid","password"],"type":"object"}

Response 204

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

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

biblio_id_pp

{"description":"Record internal identifier","in":"path","name":"biblio_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"}

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

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":"Authentication provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}

identity_provider_id_pp

{"description":"Authentication provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"}

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

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

q_body

{"description":"Query filter sent through request\"s body","in":"body","name":"query","required":false,"schema":{"type":"object"}}

q_header

{"description":"Query filter sent as a request header","in":"header","name":"x-koha-query","required":false,"type":"string"}

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_biblio_id_pp

{"description":"Record internal identifier","in":"path","name":"biblio_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_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_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":"Authentication provider domain internal identifier","in":"path","name":"identity_provider_domain_id","required":true,"type":"integer"}

swagger_yaml-parameters_identity_provider_id_pp

{"description":"Authentication provider internal identifier","in":"path","name":"identity_provider_id","required":true,"type":"integer"}

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_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-marc-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_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_header

{"description":"Query filter sent as a request header","in":"header","name":"x-koha-query","required":false,"type":"string"}

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

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","type":"integer"},"account_type":{"description":"Account line type","type":["string","null"]},"amount":{"description":"Account line amount","type":"number"},"amount_outstanding":{"description":"Outstanding amount","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_type":{"description":"Account line credit type","type":["string","null"]},"date":{"description":"Date the account line was created","format":"date-time","type":"string"},"debit_type":{"description":"Account line debit type","type":["string","null"]},"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"]},"last_increment":{"description":"The amount the line was increased last time","type":["number","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"},"payment_type":{"description":"Payment type","type":["string","null"]},"status":{"description":"The credit\/debit status","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest line update","format":"date-time","type":"string"},"user_id":{"description":"Internal patron identifier for the staff member that introduced the account line","type":["integer","null"]}},"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"}
{"$ref":"#\/definitions\/bundle_link_yaml"}
{"additionalProperties":false,"properties":{"external_id":{"description":"Item barcode","type":["string","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_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"},"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"}

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_document_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"document_id":{"description":"internally assigned identifier","type":"integer"},"file_content":{"description":"Content of the file","type":["string","null"]},"file_description":{"description":"Description of the file","type":["string","null"]},"file_name":{"description":"Name of the file","type":["string","null"]},"file_type":{"description":"Type of the file","readOnly":true,"type":["string","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"notes":{"type":["string","null"]},"physical_location":{"description":"Physical location of the document","type":["string","null"]},"uploaded_on":{"description":"Datetime of the upload","format":"date-time","readOnly":true,"type":["string","null"]},"uri":{"description":"URI of the document","type":["string","null"]}},"type":"object"}

erm_eholdings_package

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

erm_eholdings_package_agreement_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"foreign key to agreement","type":"integer"},"package_id":{"description":"foreign key to package","readOnly":true,"type":"integer"}},"required":["agreement_id"],"type":"object"}

erm_eholdings_package_yaml

{"additionalProperties":false,"properties":{"content_type":{"description":"content type of the package","type":["string","null"]},"created_on":{"description":"date of creation","type":["string","null"]},"external_id":{"description":"external id of the package","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"koha_internal_id":{"description":"internal id of the package","type":["integer","null"]},"name":{"description":"name of the package","type":"string"},"notes":{"description":"notes about the package","type":["string","null"]},"package_agreements":{"description":"agreements","items":{"$ref":"#\/definitions\/erm_eholdings_package_agreement_yaml"},"type":"array"},"package_id":{"description":"internally assigned package identifier","readOnly":true,"type":"string"},"package_type":{"description":"type of the package","type":["string","null"]},"provider":{"description":"external id of the package","type":["string","null"]},"resources":{"description":"resources","items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"},"resources_count":{"type":["integer","null"]},"vendor":{"type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["name"],"type":"object"}

erm_eholdings_resource

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

erm_eholdings_resource_yaml

{"additionalProperties":false,"properties":{"ended_on":{"description":"End date","type":["string","null"]},"is_selected":{"type":["boolean","null"]},"package":{"description":"Information about the package","type":["object","null"]},"package_id":{"description":"foreign key to the package","type":["string","null"]},"proxy":{"description":"Proxy to access this resource","type":["string","null"]},"resource_id":{"description":"internally assigned identifier","readOnly":true,"type":"string"},"started_on":{"description":"Start date","type":["string","null"]},"title":{"description":"Information about the title","type":["object","null"]},"title_id":{"description":"foreign key to the title","type":["integer","null"]},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["package_id"],"type":"object"}

erm_eholdings_title

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

erm_eholdings_title_yaml

{"additionalProperties":false,"properties":{"access_type":{"description":"access_type of the title","type":["string","null"]},"biblio_id":{"description":"internally assigned identifier for the linked biblio","readOnly":true,"type":["integer","null"]},"coverage_depth":{"description":"coverage_depth of the title","type":["string","null"]},"date_first_issue_online":{"description":"date_first_issue_online of the title","type":["string","null"]},"date_last_issue_online":{"description":"date_last_issue_online of the title","type":["string","null"]},"date_monograph_published_online":{"description":"date_monograph_published_online of the title","type":["string","null"]},"date_monograph_published_print":{"description":"date_monograph_published_print of the title","type":["string","null"]},"embargo_info":{"description":"embargo_info of the title","type":["string","null"]},"external_id":{"description":"External id of the title","type":["string","null"]},"first_author":{"description":"first_author of the title","type":["string","null"]},"first_editor":{"description":"first_editor of the title","type":["string","null"]},"is_selected":{"description":"if the title is selected in the KB","type":["boolean","null"]},"monograph_edition":{"description":"monograph_edition of the title","type":["string","null"]},"monograph_volume":{"description":"monograph_volume of the title","type":["string","null"]},"notes":{"description":"notes of the title","type":["string","null"]},"num_first_issue_online":{"description":"num_first_issue_online of the title","type":["string","null"]},"num_first_vol_online":{"description":"num_first_vol_online of the title","type":["string","null"]},"num_last_issue_online":{"description":"num_last_issue_online of the title","type":["string","null"]},"num_last_vol_online":{"description":"num_last_vol_online of the title","type":["string","null"]},"online_identifier":{"description":"online_identifier of the title","type":["string","null"]},"parent_publication_title_id":{"description":"parent_publication_title_id of the title","type":["string","null"]},"preceeding_publication_title_id":{"description":"preceeding_publication_title_id of the title","type":["string","null"]},"print_identifier":{"description":"print_identifier of the title","type":["string","null"]},"publication_title":{"description":"publication_title of the title","type":"string"},"publication_type":{"description":"publication_type of the title","type":["string","null"]},"publisher_name":{"description":"publisher_name of the title","type":["string","null"]},"resources":{"description":"Resource containing this title","items":{"$ref":"#\/definitions\/erm_eholdings_resource_yaml"},"type":"array"},"title_id":{"description":"internally assigned identifier","readOnly":true,"type":"integer"},"title_url":{"description":"title_url of the title","type":["string","null"]}},"required":["publication_title"],"type":"object"}

erm_license

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

erm_license_yaml

{"additionalProperties":false,"properties":{"description":{"description":"description of the license","type":["string","null"]},"documents":{"description":"documents","items":{"$ref":"#\/definitions\/erm_document_yaml"},"type":"array"},"ended_on":{"description":"End of the license","format":"date","type":["string","null"]},"license_id":{"description":"internally assigned license identifier","readOnly":true,"type":"integer"},"name":{"description":"name of the license","type":"string"},"started_on":{"description":"Start of the license","format":"date","type":["string","null"]},"status":{"description":"status of the license","type":"string"},"type":{"description":"description of the license","type":"string"},"user_roles":{"description":"role for users","items":{"$ref":"#\/definitions\/erm_user_role_yaml"},"type":"array"},"vendor":{"description":"Information about the vendor","type":["object","null"]},"vendor_id":{"description":"foreign key to aqbooksellers","type":["integer","null"]}},"required":["license_id","name","status","type"],"type":"object"}

erm_user_role_yaml

{"additionalProperties":false,"properties":{"agreement_id":{"description":"Internal agreement identifier","type":["integer","null"]},"license_id":{"description":"Internal license identifier","type":["integer","null"]},"patron":{"type":["object","null"]},"role":{"description":"role of the user","type":["string"]},"user_id":{"description":"Internal patron identifier","type":"integer"},"user_role_id":{"description":"Internal user_role identifier","type":"integer"}},"required":["user_id","role"],"type":"object"}

error

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

error_yaml

{"additionalProperties":true,"properties":{"error":{"description":"Error message","type":"string"},"error_code":{"description":"Error code","type":"string"}},"type":"object"}

fund

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

fund_yaml

{"additionalProperties":false,"properties":{"budget_id":{"description":"Internal identifier for the budget","type":["number","null"]},"code":{"description":"Code assigned to the fund by the user","type":["string","null"]},"fund_access":{"description":"Level of permission for this fund (1: owner, 2: owner, users and library, 3: owner and users)","type":["number","null"]},"fund_id":{"description":"internally assigned fund identifier","readOnly":true,"type":"integer"},"fund_owner_id":{"description":"Internal identifier for the fund owner","type":["number","null"]},"library_id":{"description":"Internal identifier for the library that this fund belongs to","type":["string","null"]},"name":{"description":"Name assigned to the fund by the user","type":["string","null"]},"notes":{"description":"Notes related to this fund","type":["string","null"]},"parent_fund_id":{"description":"Internal identifier for parent fund","type":["integer","null"]},"statistic1_auth_value_category":{"description":"Statistical category for this fund","type":["string","null"]},"statistic2_auth_value_category":{"description":"Second statistical category for this fund","type":["string","null"]},"timestamp":{"description":"Timestamp","format":"date-time","type":["string"]},"total_amount":{"description":"Total amount for this fund","type":["number","null"]},"warn_at_amount":{"description":"Warning at amount","type":["number","null"]},"warn_at_percentage":{"description":"Warning at percentage","type":["number","null"]}},"required":["name"],"type":"object"}

hold

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

hold_yaml

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal biblio identifier","type":"integer"},"cancellation_date":{"description":"The date the hold was cancelled","format":"date","type":["string","null"]},"cancellation_reason":{"description":"The reason the hold was cancelled","type":["string","null"]},"desk_id":{"description":"The id of the desk","type":["integer","null"]},"expiration_date":{"description":"The date the hold expires","format":"date","type":["string","null"]},"hold_date":{"description":"The date the hold was placed","format":"date","type":["string","null"]},"hold_id":{"description":"Internal hold identifier","type":"integer"},"item_group_id":{"description":"Internal item group identifier","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":["string","null"]},"item_level":{"description":"If the hold is placed at item level","type":"boolean"},"item_type":{"description":"If record level hold, the optional itemtype of the item the patron is requesting","type":["string","null"]},"lowest_priority":{"description":"Controls if the hold is given the lowest priority on the queue","type":"boolean"},"non_priority":{"description":"Set this hold as non priority","type":"boolean"},"notes":{"description":"Notes related to this hold","type":["string","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"pickup_library_id":{"description":"Internal library identifier for the pickup library","type":["string","null"]},"priority":{"description":"Where in the queue the patron sits","type":["integer","null"]},"status":{"description":"A one letter code defining what the status of the hold is after it has been confirmed","type":["string","null"]},"suspended":{"description":"Controls if the hold is suspended","type":"boolean"},"suspended_until":{"description":"Date until which the hold has been suspended","format":"date-time","type":["string","null"]},"timestamp":{"description":"Timestamp for the latest hold update","format":"date-time","type":"string"},"waiting_date":{"description":"The date the item was marked as waiting for the patron at the library","format":"date","type":["string","null"]}},"type":"object"}

holds

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

holds_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/hold_yaml"},"type":"array"}

identity_provider

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

identity_provider_domain

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

identity_provider_domain_yaml

{"additionalProperties":false,"properties":{"allow_opac":{"description":"If this domain can be used for OPAC login","type":"boolean"},"allow_staff":{"description":"If this domain can be used for staff login","type":"boolean"},"auto_register":{"description":"If patrons will be generated on login if required","type":"boolean"},"default_category_id":{"description":"Internal identifier for the default patron's category","type":["string","null"]},"default_library_id":{"description":"Internal identifier for the default library to be assigned to the new patrons","type":["string","null"]},"domain":{"description":"Matching domain ('*' used as wildcard)","type":["string","null"]},"identity_provider_domain_id":{"description":"Internally assigned authentication provider domain identifier","readOnly":true,"type":"integer"},"identity_provider_id":{"description":"Internally assigned authentication provider identifier","type":"integer"},"update_on_auth":{"description":"If patron data is updated on login","type":"boolean"}},"required":["identity_provider_domain_id","domain","auto_register","update_on_auth","default_library_id","default_category_id","allow_opac","allow_staff"],"type":"object"}

identity_provider_yaml

{"additionalProperties":false,"properties":{"code":{"description":"Authentication provider code","type":"string"},"config":{"description":"Configuration","type":"object"},"description":{"description":"User-oriented description for the provider","type":"string"},"domains":{"description":"Configured domains for the authentication provider","type":["array","null"]},"icon_url":{"description":"Icon url","type":["string","null"]},"identity_provider_id":{"description":"Internally assigned authentication provider identifier","readOnly":true,"type":"integer"},"mapping":{"description":"Attribute mapping","type":["object","null"]},"matchpoint":{"description":"Patron attribute that will be used to match","enum":["email","userid","cardnumber"],"type":"string"},"protocol":{"description":"Authentication protocol","enum":["OAuth","OIDC","CAS (not implemented)","LDAP (not implemented)"],"type":"string"}},"required":["config","code","protocol"],"type":"object"}

ill_backend

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

ill_backend_yaml

{"additionalProperties":false,"properties":{"capabilities":{"description":"List of capabilities","type":"object"},"ill_backend_id":{"description":"Internal ILL backend identifier","type":"string"}},"type":"object"}

ill_backends

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

ill_backends_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/ill_backend_yaml"},"type":"array"}

import_batch_profile

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

import_batch_profile_yaml

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

import_batch_profiles

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

import_batch_profiles_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/import_batch_profile_yaml"},"type":"array"}

import_record_match

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

import_record_match_yaml

{"additionalProperties":false,"properties":{"candidate_match_id":{"description":"Internal import record match candidate identifier","type":"integer"},"chosen":{"description":"Whether match has been chosen for overlay","type":"boolean"},"import_record_id":{"description":"Internal import record identifier","type":"integer"},"score":{"description":"Ranking value for this match calculated by the matching rules","type":"integer"}},"type":"object"}

invoice

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

invoice_yaml

{"additionalProperties":false,"properties":{"close_date":{"description":"Invoice close date (only when the invoice is closed)","format":"date","type":"string"},"closed":{"description":"If the invoice is closed","type":"boolean"},"invoice_date":{"description":"Date of billing","format":"date","type":["string","null"]},"invoice_id":{"description":"Internal identifier for the incoide. Generated on POST","type":"integer"},"invoice_number":{"description":"Invoice number assigned by the vendor","type":"string"},"shipping_cost":{"description":"Shipping cost","type":["integer","null"]},"shipping_cost_budget_id":{"description":"Shipping cost linking to budget","type":["integer","null"]},"shipping_date":{"description":"Date of shipping","format":"date","type":["string","null"]},"vendor_id":{"description":"Internal identifier for the vendor","type":"integer"}},"type":"object"}

item

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

item_group

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

item_group_yaml

{"additionalProperties":false,"properties":{"biblio_id":{"description":"Internal identifier for the parent bibliographic record","readOnly":true,"type":"integer"},"creation_date":{"description":"Date and time the item group was created","format":"date-time","readOnly":true,"type":"string"},"description":{"description":"Item group description","type":"string"},"display_order":{"description":"Item group description","type":"integer"},"item_group_id":{"description":"Internal identifier for the item group","readOnly":true,"type":"integer"},"items":{"description":"A list of items that belong to the volume (x-koha-embed)","readOnly":true,"type":["array","null"]},"modification_date":{"description":"Date and time the item group was last modified","format":"date-time","readOnly":true,"type":"string"}},"required":["item_group_id","biblio_id"],"type":"object"}

item_yaml

{"additionalProperties":false,"properties":{"_strings":{"description":"A return claims object if one exists that's unresolved","type":["object","null"]},"acquisition_date":{"description":"The date the item was acquired","format":"date","type":["string","null"]},"acquisition_source":{"description":"Information about the acquisition source (it is not really a vendor id)","type":["string","null"]},"biblio":{},"biblio_id":{"description":"Internal identifier for the parent bibliographic record","type":"integer"},"call_number_sort":{"description":"?","type":["string","null"]},"call_number_source":{"description":"Classification source used on this item","type":["string","null"]},"callnumber":{"description":"Call number for this item","type":["string","null"]},"checked_out_date":{"description":"Defines if item is checked out (NULL for not checked out, and checkout date for checked out)","format":"date","type":["string","null"]},"checkouts_count":{"description":"Number of times this item has been checked out\/issued","type":["integer","null"]},"coded_location_qualifier":{"description":"Coded location qualifier","type":["string","null"]},"collection_code":{"description":"Authorized value for the collection code associated with this item","type":["string","null"]},"copy_number":{"description":"Copy number","type":["string","null"]},"damaged_date":{"description":"The date and time an item was last marked as damaged, NULL if not damaged","type":["string","null"]},"damaged_status":{"description":"Authorized value defining this item as damaged","type":"integer"},"effective_item_type_id":{"description":"Effective itemtype defining the type for this item_id","type":["string","null"]},"effective_not_for_loan_status":{"description":"Authorized value defining why this item is not for not_for_loan_status","type":"integer"},"exclude_from_local_holds_priority":{"description":"Exclude this item from local holds priority.","type":"boolean"},"extended_subfields":{"description":"Additional 952 subfields in XML format","type":["string","null"]},"external_id":{"description":"The item's barcode","type":["string","null"]},"holding_library_id":{"description":"Library that is currently in possession item","type":["string","null"]},"holds_count":{"description":"Number of times this item has been placed on hold\/reserved","type":["integer","null"]},"home_library_id":{"description":"Internal library id for the library the item belongs to","type":["string","null"]},"internal_notes":{"description":"Non-public notes on this item","type":["string","null"]},"inventory_number":{"description":"Inventory number","type":["string","null"]},"item_id":{"description":"Internal item identifier","type":"integer"},"item_type_id":{"description":"Itemtype defining the type for this item","type":["string","null"]},"last_checkout_date":{"description":"The date the item was last checked out","format":"date","type":["string","null"]},"last_seen_date":{"description":"The date the item barcode was last scanned","format":"date","type":["string","null"]},"location":{"description":"Authorized value for the shelving location for this item","type":["string","null"]},"lost_date":{"description":"The date and time an item was last marked as lost, NULL if not lost","format":"date-time","type":["string","null"]},"lost_status":{"description":"Authorized value defining this item as lost","type":"integer"},"materials_notes":{"description":"Materials specified","type":["string","null"]},"new_status":{"description":"'new' value, whatever free-text information.","type":["string","null"]},"not_for_loan_status":{"description":"Authorized value defining why this item is not for loan","type":"integer"},"permanent_location":{"description":"Linked to the CART and PROC temporary locations feature, stores the permanent shelving location","type":["string","null"]},"public_notes":{"description":"Public notes on this item","type":["string","null"]},"purchase_price":{"description":"Purchase price","type":["number","null"]},"renewals_count":{"description":"Number of times this item has been renewed","type":["integer","null"]},"replacement_price":{"description":"Cost the library charges to replace the item (e.g. if lost)","type":["number","null"]},"replacement_price_date":{"description":"The date the replacement price is effective from","format":"date","type":["string","null"]},"restricted_status":{"description":"Authorized value defining use restrictions for this item","type":["integer","null"]},"return_claim":{"type":["object","null"]},"return_claims":{"description":"An array of all return claims associated with this item","type":"array"},"serial_issue_number":{"description":"serial enumeration\/chronology for the item","type":["string","null"]},"timestamp":{"description":"Date and time this item was last altered","format":"date-time","type":"string"},"uri":{"description":"URL for the item","type":["string","null"]},"withdrawn":{"description":"Authorized value defining this item as withdrawn","type":"integer"},"withdrawn_date":{"description":"The date and time an item was last marked as withdrawn, NULL if not withdrawn","format":"date-time","type":["string","null"]}},"required":["item_id","biblio_id","not_for_loan_status","damaged_status","lost_status","withdrawn"],"type":"object"}

job

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

job_yaml

{"additionalProperties":false,"properties":{"context":{"description":"job context","type":"object"},"data":{"description":"job data","type":"object"},"ended_date":{"description":"job end date","format":"date-time","type":["string","null"]},"enqueued_date":{"description":"job enqueue date","format":"date-time","type":"string"},"job_id":{"description":"internally assigned job identifier","readOnly":true,"type":"integer"},"patron_id":{"description":"job enqueuer","type":["string","null"]},"progress":{"description":"job progress","type":["string","null"]},"queue":{"description":"job queue","type":"string"},"size":{"description":"job size","type":["string","null"]},"started_date":{"description":"job start date","format":"date-time","type":["string","null"]},"status":{"description":"job status","type":"string"},"type":{"description":"job type","type":"string"}},"type":"object"}

library

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

library_yaml

{"additionalProperties":false,"properties":{"address1":{"description":"the first address line of the library","type":["string","null"]},"address2":{"description":"the second address line of the library","type":["string","null"]},"address3":{"description":"the third address line of the library","type":["string","null"]},"city":{"description":"the city or province of the library","type":["string","null"]},"country":{"description":"the county of the library","type":["string","null"]},"email":{"description":"the primary email address of the library","type":["string","null"]},"fax":{"description":"the fax number of the library","type":["string","null"]},"geolocation":{"description":"geolocation of your library","type":["string","null"]},"illemail":{"description":"the ILL staff email address of the library","type":["string","null"]},"ip":{"description":"the IP address for your library or branch","type":["string","null"]},"library_id":{"description":"internally assigned library identifier","maxLength":10,"minLength":1,"type":"string"},"marc_org_code":{"description":"MARC Organization Code, see http:\/\/www.loc.gov\/marc\/organizations\/orgshome.html, when empty defaults to syspref MARCOrgCode","type":["string","null"]},"name":{"description":"Printable name of library","type":"string"},"needs_override":{"description":"If the library needs an override to act as pickup location for a hold","type":"boolean"},"notes":{"description":"notes related to your library or branch","type":["string","null"]},"phone":{"description":"the primary phone of the library","type":["string","null"]},"pickup_location":{"description":"If the library can act as a pickup location","type":"boolean"},"postal_code":{"description":"the postal code of the library","type":["string","null"]},"public":{"description":"If the library is visible to the public","type":"boolean"},"reply_to_email":{"description":"the email to be used as a Reply-To","type":["string","null"]},"return_path_email":{"description":"the email to be used as Return-Path","type":["string","null"]},"smtp_server":{"description":"The library effective SMTP server","type":["object","null"]},"state":{"description":"the reqional state of the library","type":["string","null"]},"url":{"description":"the URL for your library or branch's website","type":["string","null"]}},"required":["library_id","name"],"type":"object"}

order

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

order_yaml

{"additionalProperties":false,"properties":{"basket":{"type":["object","null"]},"basket_id":{"description":"Basket this order is linked to","type":["integer","null"]},"biblio":{"type":["object","null"]},"biblio_id":{"description":"Identifier for the linked bibliographic record","type":["integer","null"]},"cancellation_date":{"description":"Date the line item was deleted","format":"date","type":["string","null"]},"cancellation_reason":{"description":"Reason of cancellation","type":["string","null"]},"claims_count":{"description":"Generated claim letters count","type":"integer"},"created_by":{"description":"Interal patron identifier of the order line creator","type":["integer","null"]},"currency":{"description":"Currency used for the purchase","type":["string","null"]},"current_item_level_holds_count":{"description":"Current holds count for associated items","type":"integer"},"date_received":{"description":"Date the order was received","format":"date","type":["string","null"]},"discount_rate":{"description":"Discount rate","type":["number","null"]},"ecost":{"description":"Effective cost","type":["number","null"]},"ecost_tax_excluded":{"description":"Effective cost (tax excluded)","type":["number","null"]},"ecost_tax_included":{"description":"Effective cost (tax included)","type":["number","null"]},"entry_date":{"description":"Date the bib was added to the basket","format":"date","type":["string","null"]},"estimated_delivery_date":{"description":"Estimated delivery date","format":"date","type":["string","null"]},"fund":{"type":["object","null"]},"fund_id":{"description":"Internal identifier for the fund this order goes against","type":"integer"},"internal_note":{"description":"Notes related to this order line, made for staff","type":["string","null"]},"invoice":{"type":["object","null"]},"invoice_id":{"description":"Id of the order invoice","type":["integer","null"]},"items":{"type":"array"},"last_claim_date":{"description":"Last date a claim letter was generated","format":"date","type":["string","null"]},"list_price":{"description":"Vendor price for the line item","type":["number","null"]},"order_id":{"description":"Internally assigned order identifier","type":"integer"},"parent_order_id":{"description":"Order ID of parent order line if exists","type":["integer","null"]},"quantity":{"description":"Ordered quantity","type":["integer","null"]},"quantity_received":{"description":"Quantity received so far","type":"integer"},"replacement_price":{"description":"Replacement cost for this item","type":["number","null"]},"rrp":{"description":"Retail cost for this item","type":["number","null"]},"rrp_tax_excluded":{"description":"Replacement cost for this item (tax excluded)","type":["number","null"]},"rrp_tax_included":{"description":"Replacement cost for this item (tax included)","type":["number","null"]},"shipping_cost":{"description":"Shipping cost","type":["number","null"]},"statistics_1":{"description":"Statistical field","type":["string","null"]},"statistics_1_authcat":{"description":"Statistical category for this order","type":["string","null"]},"statistics_2":{"description":"Statistical field (2)","type":["string","null"]},"statistics_2_authcat":{"description":"Statistical category for this order (2)","type":["string","null"]},"status":{"description":"The current order status","enum":["new","ordered","partial","complete","cancelled"],"type":"string"},"subscription":{"type":["object","null"]},"subscription_id":{"description":"Subscription ID linking the order to a subscription","type":["integer","null"]},"tax_rate_on_ordering":{"description":"Tax rate on ordering (%)","type":["number","null"]},"tax_rate_on_receiving":{"description":"Tax rate on receiving (%)","type":["number","null"]},"tax_value_on_ordering":{"description":"Tax value on ordering","type":["number","null"]},"tax_value_on_receiving":{"description":"Tax value on receiving","type":["number","null"]},"timestamp":{"description":"Date and time this order line was last modified","format":"date-time","type":"string"},"uncertain_price":{"description":"If this price was uncertain","type":"boolean"},"unit_price":{"description":"The actual cost entered when receiving this line item","type":["number","null"]},"unit_price_tax_excluded":{"description":"Unit price excluding tax (on receiving)","type":["number","null"]},"unit_price_tax_included":{"description":"Unit price including tax (on receiving)","type":["number","null"]},"vendor_note":{"description":"Notes related to this order line, made for vendor","type":["string","null"]}},"type":"object"}

patron

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

patron_account_credit

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

patron_account_credit_yaml

{"additionalProperties":false,"properties":{"account_lines_ids":{"description":"List of account line ids the credit goes against (optional)","items":{"type":"integer"},"type":"array"},"amount":{"description":"Credit amount","minimum":0,"type":"number"},"credit_type":{"description":"Type of credit ('CREDIT', 'FORGIVEN', 'LOST_FOUND', 'PAYMENT', 'WRITEOFF', 'PROCESSING_FOUND' )","type":"string"},"date":{"description":"Date the credit was recorded (optional)","format":"date","type":"string"},"description":{"description":"Description","type":"string"},"library_id":{"description":"Internal identifier for the library in which the transaction took place","type":["string","null"]},"note":{"description":"Internal note","type":"string"},"payment_type":{"description":"Payment type (only applies when credit_type=payment)","type":"string"}},"required":["amount"],"type":"object"}

patron_balance

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

patron_balance_yaml

{"additionalProperties":false,"properties":{"balance":{"description":"Signed decimal number","type":"number"},"outstanding_credits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line_yaml"},"type":"array"},"total":{"type":"number"}}},"outstanding_debits":{"properties":{"lines":{"items":{"$ref":"#\/definitions\/account_line_yaml"},"type":"array"},"total":{"type":"number"}},"type":"object"}},"required":["balance"],"type":"object"}

patron_extended_attribute

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

patron_extended_attribute_yaml

{"additionalProperties":false,"properties":{"extended_attribute_id":{"description":"Internal ID for the extended attribute","type":"integer"},"type":{"description":"Extended attribute type","type":"string"},"value":{"description":"Extended attribute value","type":["string","null"]}},"required":["type","value"],"type":"object"}

patron_yaml

{"additionalProperties":false,"properties":{"account_balance":{"description":"Balance of the patron's account","type":["number","null"]},"address":{"description":"first address line of patron's primary address","type":["string","null"]},"address2":{"description":"second address line of patron's primary address","type":["string","null"]},"altaddress_address":{"description":"first address line of patron's alternate address","type":["string","null"]},"altaddress_address2":{"description":"second address line of patron's alternate address","type":["string","null"]},"altaddress_city":{"description":"city or town of patron's alternate address","type":["string","null"]},"altaddress_country":{"description":"country of patron's alternate address","type":["string","null"]},"altaddress_email":{"description":"email address for patron's alternate address","type":["string","null"]},"altaddress_notes":{"description":"a note related to patron's alternate address","type":["string","null"]},"altaddress_phone":{"description":"phone number for patron's alternate address","type":["string","null"]},"altaddress_postal_code":{"description":"zip or postal code of patron's alternate address","type":["string","null"]},"altaddress_state":{"description":"state or province of patron's alternate address","type":["string","null"]},"altaddress_street_number":{"description":"street number of patron's alternate address","type":["string","null"]},"altaddress_street_type":{"description":"street type of patron's alternate address","type":["string","null"]},"altcontact_address":{"description":"the first address line for the alternate contact for the patron","type":["string","null"]},"altcontact_address2":{"description":"the second address line for the alternate contact for the patron","type":["string","null"]},"altcontact_city":{"description":"the city for the alternate contact for the patron","type":["string","null"]},"altcontact_country":{"description":"the country for the alternate contact for the patron","type":["string","null"]},"altcontact_firstname":{"description":"first name of alternate contact for the patron","type":["string","null"]},"altcontact_phone":{"description":"the phone number for the alternate contact for the patron","type":["string","null"]},"altcontact_postal_code":{"description":"the zipcode for the alternate contact for the patron","type":["string","null"]},"altcontact_state":{"description":"the state for the alternate contact for the patron","type":["string","null"]},"altcontact_surname":{"description":"surname or last name of the alternate contact for the patron","type":["string","null"]},"anonymized":{"description":"If the patron has been anonymized","readOnly":true,"type":"boolean"},"autorenew_checkouts":{"description":"indicate whether auto-renewal is allowed for patron","type":"boolean"},"cardnumber":{"description":"library assigned user identifier","type":["string","null"]},"category_id":{"description":"Internal identifier for the patron's category","type":"string"},"check_previous_checkout":{"description":"produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'","type":"string"},"checkouts_count":{"description":"Number of checkouts","type":["integer","null"]},"city":{"description":"city or town of patron's primary address","type":["string","null"]},"country":{"description":"country of patron's primary address","type":["string","null"]},"date_enrolled":{"description":"date the patron was added to Koha","format":"date","type":["string","null"]},"date_of_birth":{"description":"patron's date of birth","format":"date","type":["string","null"]},"date_renewed":{"description":"date the patron's card was last renewed","format":"date","type":["string","null"]},"email":{"description":"primary email address for patron's primary address","type":["string","null"]},"expiry_date":{"description":"date the patron's card is set to expire","format":"date","type":["string","null"]},"extended_attributes":{"description":"patron's extended attributes","items":{"$ref":"#\/definitions\/patron_extended_attribute_yaml"},"type":"array"},"fax":{"description":"fax number for patron's primary address","type":["string","null"]},"firstname":{"description":"patron's first name","type":["string","null"]},"gender":{"description":"patron's gender","type":["string","null"]},"incorrect_address":{"description":"set to 1 if library marked this patron as having an unconfirmed address","type":["boolean","null"]},"initials":{"description":"initials of the patron","type":["string","null"]},"lang":{"description":"lang to use to send notices to this patron","type":"string"},"last_seen":{"description":"last time a patron has been seen (connected at the OPAC or staff interface)","format":"date-time","type":["string","null"]},"library":{"description":"Library of the patron","type":["object","null"]},"library_id":{"description":"Internal identifier for the patron's home library","type":"string"},"login_attempts":{"description":"number of failed login attemps","type":["integer","null"]},"middle_name":{"description":"patron's middle name","type":["string","null"]},"mobile":{"description":"the other phone number for patron's primary address","type":["string","null"]},"opac_notes":{"description":"a note on the patron's account visible in OPAC and staff interface","type":["string","null"]},"other_name":{"description":"any other names associated with the patron","type":["string","null"]},"overdrive_auth_token":{"description":"persist OverDrive auth token","type":["string","null"]},"overdues_count":{"description":"Number of overdued checkouts","type":["integer","null"]},"patron_card_lost":{"description":"set to 1 if library marked this patron as having lost his card","type":["boolean","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"phone":{"description":"primary phone number for patron's primary address","type":["string","null"]},"postal_code":{"description":"zip or postal code of patron's primary address","type":["string","null"]},"privacy":{"description":"patron's privacy settings related to their checkout history","type":"integer"},"privacy_guarantor_checkouts":{"description":"controls if relatives can see this patron's checkouts","type":"integer"},"privacy_guarantor_fines":{"description":"controls if relatives can see this patron's fines","type":"boolean"},"pronouns":{"description":"pronouns of the patron","type":["string","null"]},"relationship_type":{"description":"used for children to include the relationship to their guarantor","type":["string","null"]},"restricted":{"description":"If any restriction applies to the patron","readOnly":true,"type":"boolean"},"secondary_email":{"description":"secondary email address for patron's primary address","type":["string","null"]},"secondary_phone":{"description":"secondary phone number for patron's primary address","type":["string","null"]},"sms_number":{"description":"the mobile phone number where the patron would like to receive notices (if SMS turned on)","type":["string","null"]},"sms_provider_id":{"description":"the provider of the mobile phone number defined in smsalertnumber","type":["integer","null"]},"staff_notes":{"description":"a note on the patron's account","type":["string","null"]},"state":{"description":"state or province of patron's primary address","type":["string","null"]},"statistics_1":{"description":"a field that can be used for any information unique to the library","type":["string","null"]},"statistics_2":{"description":"a field that can be used for any information unique to the library","type":["string","null"]},"street_number":{"description":"street number of patron's primary address","type":["string","null"]},"street_type":{"description":"street type of patron's primary address","type":["string","null"]},"surname":{"description":"patron's last name","type":["string","null"]},"title":{"description":"patron's title","type":["string","null"]},"updated_on":{"description":"time of last change could be useful for synchronization with external systems (among others)","format":"date-time","type":"string"},"userid":{"description":"patron's login","type":["string","null"]}},"required":["surname","library_id","category_id"],"type":"object"}

quote

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

quote_yaml

{"additionalProperties":false,"properties":{"displayed_on":{"description":"Last display date","type":["string","null"]},"quote_id":{"description":"internally assigned quote identifier","type":"integer"},"source":{"description":"source of the quote","type":"string"},"text":{"description":"text","type":["string","null"]}},"required":["source","text"],"type":"object"}

renewal

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

renewal_yaml

{"additionalProperties":false,"properties":{"checkout_id":{"description":"internally assigned checkout identifier","type":"integer"},"interface":{"description":"Interface from which the renewal took place (values can be: api, cron, commandline, intranet, opac and sip)","type":["string","null"]},"renewal_date":{"description":"Date the renewal took place","format":"date-time","type":"string"},"renewal_id":{"description":"internally assigned renewal identifier","type":"integer"},"renewal_type":{"enum":["Automatic","Manual"],"type":["string","null"]},"renewer":{"description":"The object representing the renewal issuer","type":["object","null"]},"renewer_id":{"description":"internally assigned for the user that processed the renewal","type":["integer","null"]},"seen":{"description":"Seen\/Unseen renewal","type":["boolean"]},"timestamp":{"description":"Last update time","type":"string"}},"type":"object"}

renewals

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

renewals_yaml

{"additionalProperties":false,"items":{"$ref":"#\/definitions\/renewal_yaml"},"type":"array"}

return_claim

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

return_claim_yaml

{"additionalProperties":false,"properties":{"claim_id":{"description":"internally assigned return claim identifier","type":["integer"]},"created_by":{"description":"patron id of librarian who made the claim","type":["integer","null"]},"created_on":{"description":"date of claim creation","format":"date-time","type":["string","null"]},"issue_id":{"description":"internal identifier of the claimed checkout if still checked out","type":["integer","null"]},"item_id":{"description":"internal identifier of the claimed item","type":["integer"]},"notes":{"description":"notes about this claim","type":["string","null"]},"old_issue_id":{"description":"internal identifier of the claimed checkout if not longer checked out","type":["integer","null"]},"patron_id":{"description":"Internal patron identifier","type":"integer"},"resolution":{"description":"code of resolution type for this claim","type":["string","null"]},"resolved_by":{"description":"patron id of librarian who resolved this claim","type":["integer","null"]},"resolved_on":{"description":"date the claim was resolved","format":"date-time","type":["string","null"]},"updated_by":{"description":"patron id of librarian who last updated the claim","type":["integer","null"]},"updated_on":{"description":"date the claim was last updated","format":"date-time","type":["string","null"]}},"type":"object"}

search_filter

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

search_filter_yaml

{"additionalProperties":false,"properties":{"limits":{"description":"filter limits part","type":["string","null"]},"name":{"description":"filter name","type":"string"},"opac":{"description":"visible on opac","type":["boolean","null"]},"query":{"description":"filter query part","type":["string","null"]},"search_filter_id":{"description":"internally assigned search filter identifier","readOnly":true,"type":"integer"},"staff_client":{"description":"visible in staff client","type":["boolean","null"]}},"required":["name"],"type":"object"}

smtp_server

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

smtp_server_yaml

{"additionalProperties":false,"properties":{"debug":{"description":"If the SMTP connection is set to debug mode","type":"boolean"},"host":{"description":"SMTP host name","type":"string"},"name":{"description":"Name of the SMTP server","type":"string"},"password":{"description":"The password to use for authentication (optional)","type":["string","null"]},"port":{"description":"TCP port number","type":"integer"},"smtp_server_id":{"description":"Internal SMTP server identifier","readOnly":true,"type":"integer"},"ssl_mode":{"description":"If SSL\/TLS will be used","enum":["disabled","ssl","starttls"],"type":"string"},"timeout":{"description":"Maximum time in seconds to wait for server","type":"integer"},"user_name":{"description":"The user name to use for authentication (optional)","type":["string","null"]}},"required":["name"],"type":"object"}

suggestion

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

suggestion_yaml

{"additionalProperties":false,"properties":{"accepted_by":{"description":"patron_id for the librarian who accepted the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"accepted_date":{"description":"date the suggestion was marked as accepted","format":"date","type":["string","null"]},"archived":{"description":"archived (processed) suggestion","type":["boolean","null"]},"author":{"description":"author of the suggested item","type":["string","null"]},"biblio_id":{"description":"foreign key linking the suggestion to the biblio table after the suggestion has been ordered","type":["integer","null"]},"budget_id":{"description":"foreign key linking the suggested budget to the aqbudgets table","type":["integer","null"]},"collection_title":{"description":"collection name for the suggested item","type":["string","null"]},"copyright_date":{"description":"copyright date of the suggested item","type":["integer","null"]},"currency":{"description":"suggested currency for the suggested price","type":["string","null"]},"isbn":{"description":"isbn of the suggested item","type":["string","null"]},"item_price":{"description":"suggested price","type":["number","null"]},"item_type":{"description":"suggested item type","type":["string","null"]},"last_status_change_by":{"description":"patron the suggestion was last modified by","type":["integer","null"]},"last_status_change_date":{"description":"date the suggestion was last modified","format":"date","type":["string","null"]},"library_id":{"description":"foreign key linking the suggested branch to the branches table","type":["string","null"]},"managed_by":{"description":"patron_id for the librarian managing the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"managed_date":{"description":"date the suggestion was updated","format":"date","type":["string","null"]},"note":{"description":"note entered on the suggestion","type":["string","null"]},"patron_reason":{"description":"reason for making the suggestion","type":["string","null"]},"publication_place":{"description":"publication place of the suggested item","type":["string","null"]},"publication_year":{"description":"year of publication","type":["string","null"]},"publisher_code":{"description":"publisher of the suggested item","type":["string","null"]},"quantity":{"description":"suggested quantity to be purchased","type":["string","null"]},"reason":{"description":"reason for accepting or rejecting the suggestion","type":["string","null"]},"rejected_by":{"description":"patron_id for the librarian who rejected the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"rejected_date":{"description":"date the suggestion was marked as rejected","format":"date","type":["string","null"]},"staff_note":{"description":"non-public note entered on the suggestion","type":["string","null"]},"status":{"description":"Suggestion status","enum":["ASKED","CHECKED","ACCEPTED","REJECTED"],"type":"string"},"suggested_by":{"description":"patron_id for the person making the suggestion, foreign key linking to the borrowers table","type":["integer","null"]},"suggestion_date":{"description":"the suggestion was submitted","format":"date","type":"string"},"suggestion_id":{"description":"unique identifier assigned automatically by Koha","readOnly":true,"type":"integer"},"timestamp":{"description":"timestamp of date created","format":"date-time","type":["string","null"]},"title":{"description":"title of the suggested item","type":["string","null"]},"total_price":{"description":"suggested total cost (price*quantity updated for currency)","type":["string","null"]},"volume_desc":{"description":"volume description","type":["string","null"]}},"type":"object"}

transfer_limit

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

transfer_limit_yaml

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

vendor

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

vendor_yaml

{"additionalProperties":false,"properties":{"accountnumber":{"description":"Vendor account number","type":["string","null"]},"active":{"description":"Is this vendor active","type":["boolean","null"]},"address1":{"description":"Vendor physical address (line 1)","type":["string","null"]},"address2":{"description":"Vendor physical address (line 2)","type":["string","null"]},"address3":{"description":"Vendor physical address (line 3)","type":["string","null"]},"address4":{"description":"Vendor physical address (line 4)","type":["string","null"]},"deliverytime":{"description":"Expected delivery time (in days)","type":["integer","null"]},"discount":{"description":"Default discount rate for items ordered from this vendor","type":["number","null"]},"external_id":{"description":"External id","type":["string","null"]},"fax":{"description":"Vendor fax number","type":["string","null"]},"gst":{"description":"Is the library taxed when buying from this vendor","type":["boolean","null"]},"id":{"description":"internally assigned vendor identifier","readOnly":true,"type":"integer"},"invoice_currency":{"description":"Invoice prices currency","type":["string","null"]},"invoice_includes_gst":{"description":"Invoice prices include taxes","type":["boolean","null"]},"list_currency":{"description":"List prices currency","type":["string","null"]},"list_includes_gst":{"description":"List prices include taxes","type":["boolean","null"]},"name":{"description":"Vendor name","type":["string"]},"notes":{"description":"Vendor notes","type":["string","null"]},"phone":{"description":"Vendor phone number","type":["string","null"]},"postal":{"description":"Vendor postal address","type":["string","null"]},"tax_rate":{"description":"Default tax rate for items ordered from this vendor","type":["number","null"]},"type":{"description":"Type of vendor","type":["string","null"]},"url":{"description":"Vendor web address","type":["string","null"]}},"required":["name"],"type":"object"}