21.05 20.11 20.05 19.11 Development

Koha REST API (1)

Download OpenAPI specification:Download

oauth

tokenOAuth

Request Body schema: application/x-www-form-urlencoded
grant_type
required
string

grant type (client_credentials)

client_id
string

client id

client_secret
string

client secret

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

acquisitions

listVendors

query Parameters
name
string

Case insensitive search on vendor name

accountnumber
string

Case insensitive search on vendor's account number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addVendor

Request Body schema: application/json

A JSON object representing a vendor

name
required
string

Vendor name

address1
string Nullable

Vendor physical address (line 1)

address2
string Nullable

Vendor physical address (line 2)

address3
string Nullable

Vendor physical address (line 3)

address4
string Nullable

Vendor physical address (line 4)

phone
string Nullable

Vendor phone number

fax
string Nullable

Vendor fax number

accountnumber
string Nullable

Vendor account number

notes
string Nullable

Vendor notes

postal
string Nullable

Vendor postal address

url
string Nullable

Vendor web address

active
boolean Nullable

Is this vendor active

list_currency
string Nullable

List prices currency

invoice_currency
string Nullable

Invoice prices currency

gst
boolean Nullable

Is the library taxed when buying from this vendor

list_includes_gst
boolean Nullable

List prices include taxes

invoice_includes_gst
boolean Nullable

Invoice prices include taxes

tax_rate
number Nullable

Default tax rate for items ordered from this vendor

discount
number Nullable

Default discount rate for items ordered from this vendor

deliverytime
integer Nullable

Expected delivery time (in days)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

getVendor

path Parameters
vendor_id
required
integer

Vendor id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

updateVendor

path Parameters
vendor_id
required
integer

Vendor id

Request Body schema: application/json

A JSON object representing a vendor

name
required
string

Vendor name

address1
string Nullable

Vendor physical address (line 1)

address2
string Nullable

Vendor physical address (line 2)

address3
string Nullable

Vendor physical address (line 3)

address4
string Nullable

Vendor physical address (line 4)

phone
string Nullable

Vendor phone number

fax
string Nullable

Vendor fax number

accountnumber
string Nullable

Vendor account number

notes
string Nullable

Vendor notes

postal
string Nullable

Vendor postal address

url
string Nullable

Vendor web address

active
boolean Nullable

Is this vendor active

list_currency
string Nullable

List prices currency

invoice_currency
string Nullable

Invoice prices currency

gst
boolean Nullable

Is the library taxed when buying from this vendor

list_includes_gst
boolean Nullable

List prices include taxes

invoice_includes_gst
boolean Nullable

Invoice prices include taxes

tax_rate
number Nullable

Default tax rate for items ordered from this vendor

discount
number Nullable

Default discount rate for items ordered from this vendor

deliverytime
integer Nullable

Expected delivery time (in days)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

deleteVendor

path Parameters
vendor_id
required
integer

Vendor id

Responses

Response samples

Content type
application/json
"string"

listFunds

query Parameters
name
string

Case insensitive search on fund name

fund_owner_id
integer

Display only the funds that belongs to the given patron ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vendors

listVendors

query Parameters
name
string

Case insensitive search on vendor name

accountnumber
string

Case insensitive search on vendor's account number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addVendor

Request Body schema: application/json

A JSON object representing a vendor

name
required
string

Vendor name

address1
string Nullable

Vendor physical address (line 1)

address2
string Nullable

Vendor physical address (line 2)

address3
string Nullable

Vendor physical address (line 3)

address4
string Nullable

Vendor physical address (line 4)

phone
string Nullable

Vendor phone number

fax
string Nullable

Vendor fax number

accountnumber
string Nullable

Vendor account number

notes
string Nullable

Vendor notes

postal
string Nullable

Vendor postal address

url
string Nullable

Vendor web address

active
boolean Nullable

Is this vendor active

list_currency
string Nullable

List prices currency

invoice_currency
string Nullable

Invoice prices currency

gst
boolean Nullable

Is the library taxed when buying from this vendor

list_includes_gst
boolean Nullable

List prices include taxes

invoice_includes_gst
boolean Nullable

Invoice prices include taxes

tax_rate
number Nullable

Default tax rate for items ordered from this vendor

discount
number Nullable

Default discount rate for items ordered from this vendor

deliverytime
integer Nullable

Expected delivery time (in days)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

getVendor

path Parameters
vendor_id
required
integer

Vendor id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

updateVendor

path Parameters
vendor_id
required
integer

Vendor id

Request Body schema: application/json

A JSON object representing a vendor

name
required
string

Vendor name

address1
string Nullable

Vendor physical address (line 1)

address2
string Nullable

Vendor physical address (line 2)

address3
string Nullable

Vendor physical address (line 3)

address4
string Nullable

Vendor physical address (line 4)

phone
string Nullable

Vendor phone number

fax
string Nullable

Vendor fax number

accountnumber
string Nullable

Vendor account number

notes
string Nullable

Vendor notes

postal
string Nullable

Vendor postal address

url
string Nullable

Vendor web address

active
boolean Nullable

Is this vendor active

list_currency
string Nullable

List prices currency

invoice_currency
string Nullable

Invoice prices currency

gst
boolean Nullable

Is the library taxed when buying from this vendor

list_includes_gst
boolean Nullable

List prices include taxes

invoice_includes_gst
boolean Nullable

Invoice prices include taxes

tax_rate
number Nullable

Default tax rate for items ordered from this vendor

discount
number Nullable

Default discount rate for items ordered from this vendor

deliverytime
integer Nullable

Expected delivery time (in days)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "phone": "string",
  • "fax": "string",
  • "accountnumber": "string",
  • "notes": "string",
  • "postal": "string",
  • "url": "string",
  • "active": true,
  • "list_currency": "string",
  • "invoice_currency": "string",
  • "gst": true,
  • "list_includes_gst": true,
  • "invoice_includes_gst": true,
  • "tax_rate": 0,
  • "discount": 0,
  • "deliverytime": 0
}

deleteVendor

path Parameters
vendor_id
required
integer

Vendor id

Responses

Response samples

Content type
application/json
"string"

funds

listFunds

query Parameters
name
string

Case insensitive search on fund name

fund_owner_id
integer

Display only the funds that belongs to the given patron ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

patrons

listCheckouts

query Parameters
patron_id
integer

Internal patron identifier

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

checked_in
boolean

By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "checkout_id": 0,
  • "patron_id": 0,
  • "item_id": 0,
  • "due_date": "2019-08-24T14:15:22Z",
  • "library_id": "string",
  • "checkin_date": "2019-08-24T14:15:22Z",
  • "last_renewed_date": "2019-08-24T14:15:22Z",
  • "renewals": 0,
  • "auto_renew": true,
  • "auto_renew_error": "string",
  • "timestamp": "string",
  • "checkout_date": "2019-08-24T14:15:22Z",
  • "onsite_checkout": true,
  • "note": "string",
  • "note_date": "2019-08-24"
}

renewCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "checkout_id": 0,
  • "patron_id": 0,
  • "item_id": 0,
  • "due_date": "2019-08-24T14:15:22Z",
  • "library_id": "string",
  • "checkin_date": "2019-08-24T14:15:22Z",
  • "last_renewed_date": "2019-08-24T14:15:22Z",
  • "renewals": 0,
  • "auto_renew": true,
  • "auto_renew_error": "string",
  • "timestamp": "string",
  • "checkout_date": "2019-08-24T14:15:22Z",
  • "onsite_checkout": true,
  • "note": "string",
  • "note_date": "2019-08-24"
}

listHolds

query Parameters
hold_id
integer

Internal reserve identifier

patron_id
integer

Internal patron identifier

hold_date
string <date>

Hold

biblio_id
integer

Internal biblio identifier

pickup_library_id
string

Internal library identifier for the pickup library

cancellation_date
string <date>

The date the hold was cancelled

notes
string

Notes related to this hold

priority
integer

Where in the queue the patron sits

status
string

Found status

timestamp
string

Time of latest update

item_id
integer

Internal item identifier

waiting_date
string

Date the item was marked as waiting for the patron

expiration_date
string

Date the hold expires

lowest_priority
boolean

Lowest priority

suspended
boolean

Suspended

suspended_until
string

Suspended until

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addHold

Request Body schema: application/json

A JSON object containing informations about the new hold

patron_id
required
integer

Internal patron identifier

biblio_id
integer Nullable

Internal biblio identifier

item_id
integer Nullable

Internal item identifier

pickup_library_id
required
string

Internal library identifier for the pickup library

expiration_date
string <date> Nullable

Hold end date

notes
string Nullable

Notes related to this hold

item_type
string Nullable

Limit hold on one itemtype (ignored for item-level holds)

Responses

Request samples

Content type
application/json
{
  • "patron_id": 0,
  • "biblio_id": 0,
  • "item_id": 0,
  • "pickup_library_id": "string",
  • "expiration_date": "2019-08-24",
  • "notes": "string",
  • "item_type": "string"
}

Response samples

Content type
application/json
{
  • "hold_id": 0,
  • "patron_id": 0,
  • "hold_date": "2019-08-24",
  • "biblio_id": 0,
  • "pickup_library_id": "string",
  • "cancellation_date": "2019-08-24",
  • "notes": "string",
  • "priority": 0,
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "item_id": "string",
  • "waiting_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "lowest_priority": true,
  • "suspended": true,
  • "suspended_until": "2019-08-24T14:15:22Z",
  • "item_type": "string",
  • "item_level": true
}

allows_renewalCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "allows_renewal": true,
  • "max_renewals": 0,
  • "current_renewals": 0,
  • "error": "string"
}

listPatrons

query Parameters
patron_id
string

Search on patron_id

cardnumber
string

Case insensitive search on cardnumber

surname
string

Case insensitive search on surname

firstname
string

Case insensitive search on firstname

title
string

Case insensitive search on title

other_name
string

Case insensitive search on othernames

initials
string

Case insensitive search on initials

street_number
string

Case insensitive search on streetnumber

street_type
string

Case insensitive search on streettype

address
string

Case insensitive search on address

address2
string

Case insensitive search on address2

city
string

Case insensitive search on city

state
string

Case insensitive search on state

postal_code
string

Case insensitive search on zipcode

country
string

Case insensitive search on country

email
string

Case insensitive search on email

phone
string

Case insensitive search on phone

mobile
string

Case insensitive search on mobile

fax
string

Case insensitive search on fax

secondary_email
string

Case insensitive search on secondary_email

secondary_phone
string

Case insensitive search on secondary_phone

altaddress_street_number
string

Case insensitive search on altaddress_street_number

altaddress_street_type
string

Case insensitive search on altaddress_street_type

altaddress_address
string

Case insensitive search on altaddress_address

altaddress_address2
string

Case insensitive search on altaddress_address2

altaddress_city
string

Case insensitive search on altaddress_city

altaddress_state
string

Case insensitive search on altaddress_state

altaddress_postal_code
string

Case insensitive search on altaddress_postal_code

altaddress_country
string

Case insensitive search on altaddress_country

altaddress_email
string

Case insensitive search on altaddress_email

altaddress_phone
string

Case insensitive search on altaddress_phone

date_of_birth
string

Case insensitive search on date_of_birth

library_id
string

Case insensitive search on library_id

category_id
string

Case insensitive search on category_id

date_enrolled
string

Case insensitive search on date_enrolled

expiry_date
string

Case insensitive search on expiry_date

incorrect_address
boolean

Search on incorrect_address

patron_card_lost
boolean

Search on patron_card_lost

restricted
boolean

Filter search by restricted

guarantor_id
string

Search on guarantor_id

staff_notes
string

Case insensitive search on staff_notes

relationship_type
string

Case insensitive search on relationship_type

gender
string

Case insensitive search on gender

userid
string

Case insensitive search on userid

opac_notes
string

Case insensitive search on opac_notes

altaddress_notes
string

Case insensitive search on altaddress_notes

statistics_1
string

Case insensitive search on statistics_1

statistics_2
string

Case insensitive search on statistics_2

altcontact_firstname
string

Case insensitive search on altcontact_firstname

altcontact_surname
string

Case insensitive search on altcontact_surname

altcontact_address
string

Case insensitive search on altcontact_address

altcontact_address2
string

Case insensitive search on altcontact_address2

altcontact_city
string

Case insensitive search on altcontact_city

altcontact_state
string

Case insensitive search on altcontact_state

altcontact_postal_code
string

Case insensitive search on altcontact_postal_code

altcontact_country
string

Case insensitive search on altcontact_country

altcontact_phone
string

Case insensitive search on altcontact_phone

sms_number
string

Case insensitive search on sms_number

sms_provider_id
string

Case insensitive search on sms_provider_id

privacy
string

Search on privacy

privacy_guarantor_checkouts
string

Search on privacy_guarantor_checkouts

check_previous_checkout
string

Case insensitive search on check_previous_checkout

updated_on
string

Search on updated_on

last_seen
string

Case insensitive search on last_seen

lang
string

Case insensitive search on lang

login_attempts
string

Search on login_attempts

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addPatron

Request Body schema: application/json

A JSON object containing information about the new patron

patron_id
integer

Internal patron identifier

cardnumber
stringnull

library assigned user identifier

surname
required
stringnull

patron's last name

firstname
stringnull

patron's first name

title
string Nullable

patron's title

other_name
string Nullable

any other names associated with the patron

initials
string Nullable

initials of the patron

street_number
string Nullable

street number of patron's primary address

street_type
string Nullable

street type of patron's primary address

address
required
string Nullable

first address line of patron's primary address

address2
string Nullable

second address line of patron's primary address

city
required
string Nullable

city or town of patron's primary address

state
string Nullable

state or province of patron's primary address

postal_code
string Nullable

zip or postal code of patron's primary address

country
string Nullable

country of patron's primary address

email
stringnull

primary email address for patron's primary address

phone
stringnull

primary phone number for patron's primary address

mobile
string Nullable

the other phone number for patron's primary address

fax
string Nullable

fax number for patron's primary address

secondary_email
string Nullable

secondary email address for patron's primary address

secondary_phone
string Nullable

secondary phone number for patron's primary address

altaddress_street_number
string Nullable

street number of patron's alternate address

altaddress_street_type
string Nullable

street type of patron's alternate address

altaddress_address
string Nullable

first address line of patron's alternate address

altaddress_address2
string Nullable

second address line of patron's alternate address

altaddress_city
string Nullable

city or town of patron's alternate address

altaddress_state
string Nullable

state or province of patron's alternate address

altaddress_postal_code
string Nullable

zip or postal code of patron's alternate address

altaddress_country
string Nullable

country of patron's alternate address

altaddress_email
string Nullable

email address for patron's alternate address

altaddress_phone
string Nullable

phone number for patron's alternate address

date_of_birth
string <date> Nullable

patron's date of birth

library_id
required
string

Internal identifier for the patron's home library

category_id
required
string

Internal identifier for the patron's category

date_enrolled
string <date> Nullable

date the patron was added to Koha

expiry_date
string <date> Nullable

date the patron's card is set to expire

date_renewed
string Nullable

date the patron's card was last renewed

incorrect_address
boolean Nullable

set to 1 if library marked this patron as having an unconfirmed address

patron_card_lost
boolean Nullable

set to 1 if library marked this patron as having lost his card

staff_notes
string Nullable

a note on the patron's account

relationship_type
string Nullable

used for children to include the relationship to their guarantor

gender
string Nullable

patron's gender

userid
string Nullable

patron's login

opac_notes
string Nullable

a note on the patron's account visible in OPAC and staff client

altaddress_notes
string Nullable

a note related to patron's alternate address

statistics_1
string Nullable

a field that can be used for any information unique to the library

statistics_2
string Nullable

a field that can be used for any information unique to the library

altcontact_firstname
string Nullable

first name of alternate contact for the patron

altcontact_surname
string Nullable

surname or last name of the alternate contact for the patron

altcontact_address
string Nullable

the first address line for the alternate contact for the patron

altcontact_address2
string Nullable

the second address line for the alternate contact for the patron

altcontact_city
string Nullable

the city for the alternate contact for the patron

altcontact_state
string Nullable

the state for the alternate contact for the patron

altcontact_postal_code
string Nullable

the zipcode for the alternate contact for the patron

altcontact_country
string Nullable

the country for the alternate contact for the patron

altcontact_phone
string Nullable

the phone number for the alternate contact for the patron

sms_number
string Nullable

the mobile phone number where the patron would like to receive notices (if SMS turned on)

sms_provider_id
integer Nullable

the provider of the mobile phone number defined in smsalertnumber

privacy
integer

patron's privacy settings related to their reading history

privacy_guarantor_checkouts
integer

controls if relatives can see this patron's checkouts

privacy_guarantor_fines
boolean

controls if relatives can see this patron's fines

check_previous_checkout
string

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'

updated_on
string <date-time>

time of last change could be useful for synchronization with external systems (among others)

last_seen
string <date-time> Nullable

last time a patron has been seen (connected at the OPAC or staff interface)

lang
string

lang to use to send notices to this patron

login_attempts
integer Nullable

number of failed login attemps

overdrive_auth_token
string Nullable

persist OverDrive auth token

Responses

Request samples

Content type
application/json
{
  • "patron_id": 0,
  • "cardnumber": null,
  • "surname": null,
  • "firstname": null,
  • "title": "string",
  • "other_name": "string",
  • "initials": "string",
  • "street_number": "string",
  • "street_type": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string",
  • "email": null,
  • "phone": null,
  • "mobile": "string",
  • "fax": "string",
  • "secondary_email": "string",
  • "secondary_phone": "string",
  • "altaddress_street_number": "string",
  • "altaddress_street_type": "string",
  • "altaddress_address": "string",
  • "altaddress_address2": "string",
  • "altaddress_city": "string",
  • "altaddress_state": "string",
  • "altaddress_postal_code": "string",
  • "altaddress_country": "string",
  • "altaddress_email": "string",
  • "altaddress_phone": "string",
  • "date_of_birth": "2019-08-24",
  • "library_id": "string",
  • "category_id": "string",
  • "date_enrolled": "2019-08-24",
  • "expiry_date": "2019-08-24",
  • "date_renewed": "string",
  • "incorrect_address": true,
  • "patron_card_lost": true,
  • "staff_notes": "string",
  • "relationship_type": "string",
  • "gender": "string",
  • "userid": "string",
  • "opac_notes": "string",
  • "altaddress_notes": "string",
  • "statistics_1": "string",
  • "statistics_2": "string",
  • "altcontact_firstname": "string",
  • "altcontact_surname": "string",
  • "altcontact_address": "string",
  • "altcontact_address2": "string",
  • "altcontact_city": "string",
  • "altcontact_state": "string",
  • "altcontact_postal_code": "string",
  • "altcontact_country": "string",
  • "altcontact_phone": "string",
  • "sms_number": "string",
  • "sms_provider_id": 0,
  • "privacy": 0,
  • "privacy_guarantor_checkouts": 0,
  • "privacy_guarantor_fines": true,
  • "check_previous_checkout": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "last_seen": "2019-08-24T14:15:22Z",
  • "lang": "string",
  • "login_attempts": 0,
  • "overdrive_auth_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

getPatron

path Parameters
patron_id
required
integer

Internal patron identifier

Responses

Response samples

Content type
application/json
{
  • "patron_id": 0,
  • "cardnumber": null,
  • "surname": null,
  • "firstname": null,
  • "title": "string",
  • "other_name": "string",
  • "initials": "string",
  • "street_number": "string",
  • "street_type": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string",
  • "email": null,
  • "phone": null,
  • "mobile": "string",
  • "fax": "string",
  • "secondary_email": "string",
  • "secondary_phone": "string",
  • "altaddress_street_number": "string",
  • "altaddress_street_type": "string",
  • "altaddress_address": "string",
  • "altaddress_address2": "string",
  • "altaddress_city": "string",
  • "altaddress_state": "string",
  • "altaddress_postal_code": "string",
  • "altaddress_country": "string",
  • "altaddress_email": "string",
  • "altaddress_phone": "string",
  • "date_of_birth": "2019-08-24",
  • "library_id": "string",
  • "category_id": "string",
  • "date_enrolled": "2019-08-24",
  • "expiry_date": "2019-08-24",
  • "date_renewed": "string",
  • "incorrect_address": true,
  • "patron_card_lost": true,
  • "restricted": true,
  • "staff_notes": "string",
  • "relationship_type": "string",
  • "gender": "string",
  • "userid": "string",
  • "opac_notes": "string",
  • "altaddress_notes": "string",
  • "statistics_1": "string",
  • "statistics_2": "string",
  • "altcontact_firstname": "string",
  • "altcontact_surname": "string",
  • "altcontact_address": "string",
  • "altcontact_address2": "string",
  • "altcontact_city": "string",
  • "altcontact_state": "string",
  • "altcontact_postal_code": "string",
  • "altcontact_country": "string",
  • "altcontact_phone": "string",
  • "sms_number": "string",
  • "sms_provider_id": 0,
  • "privacy": 0,
  • "privacy_guarantor_checkouts": 0,
  • "privacy_guarantor_fines": true,
  • "check_previous_checkout": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "last_seen": "2019-08-24T14:15:22Z",
  • "lang": "string",
  • "login_attempts": 0,
  • "overdrive_auth_token": "string",
  • "anonymized": true
}

updatePatron

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A JSON object containing new information about existing patron

patron_id
integer

Internal patron identifier

cardnumber
stringnull

library assigned user identifier

surname
required
stringnull

patron's last name

firstname
stringnull

patron's first name

title
string Nullable

patron's title

other_name
string Nullable

any other names associated with the patron

initials
string Nullable

initials of the patron

street_number
string Nullable

street number of patron's primary address

street_type
string Nullable

street type of patron's primary address

address
required
string Nullable

first address line of patron's primary address

address2
string Nullable

second address line of patron's primary address

city
required
string Nullable

city or town of patron's primary address

state
string Nullable

state or province of patron's primary address

postal_code
string Nullable

zip or postal code of patron's primary address

country
string Nullable

country of patron's primary address

email
stringnull

primary email address for patron's primary address

phone
stringnull

primary phone number for patron's primary address

mobile
string Nullable

the other phone number for patron's primary address

fax
string Nullable

fax number for patron's primary address

secondary_email
string Nullable

secondary email address for patron's primary address

secondary_phone
string Nullable

secondary phone number for patron's primary address

altaddress_street_number
string Nullable

street number of patron's alternate address

altaddress_street_type
string Nullable

street type of patron's alternate address

altaddress_address
string Nullable

first address line of patron's alternate address

altaddress_address2
string Nullable

second address line of patron's alternate address

altaddress_city
string Nullable

city or town of patron's alternate address

altaddress_state
string Nullable

state or province of patron's alternate address

altaddress_postal_code
string Nullable

zip or postal code of patron's alternate address

altaddress_country
string Nullable

country of patron's alternate address

altaddress_email
string Nullable

email address for patron's alternate address

altaddress_phone
string Nullable

phone number for patron's alternate address

date_of_birth
string <date> Nullable

patron's date of birth

library_id
required
string

Internal identifier for the patron's home library

category_id
required
string

Internal identifier for the patron's category

date_enrolled
string <date> Nullable

date the patron was added to Koha

expiry_date
string <date> Nullable

date the patron's card is set to expire

date_renewed
string Nullable

date the patron's card was last renewed

incorrect_address
boolean Nullable

set to 1 if library marked this patron as having an unconfirmed address

patron_card_lost
boolean Nullable

set to 1 if library marked this patron as having lost his card

staff_notes
string Nullable

a note on the patron's account

relationship_type
string Nullable

used for children to include the relationship to their guarantor

gender
string Nullable

patron's gender

userid
string Nullable

patron's login

opac_notes
string Nullable

a note on the patron's account visible in OPAC and staff client

altaddress_notes
string Nullable

a note related to patron's alternate address

statistics_1
string Nullable

a field that can be used for any information unique to the library

statistics_2
string Nullable

a field that can be used for any information unique to the library

altcontact_firstname
string Nullable

first name of alternate contact for the patron

altcontact_surname
string Nullable

surname or last name of the alternate contact for the patron

altcontact_address
string Nullable

the first address line for the alternate contact for the patron

altcontact_address2
string Nullable

the second address line for the alternate contact for the patron

altcontact_city
string Nullable

the city for the alternate contact for the patron

altcontact_state
string Nullable

the state for the alternate contact for the patron

altcontact_postal_code
string Nullable

the zipcode for the alternate contact for the patron

altcontact_country
string Nullable

the country for the alternate contact for the patron

altcontact_phone
string Nullable

the phone number for the alternate contact for the patron

sms_number
string Nullable

the mobile phone number where the patron would like to receive notices (if SMS turned on)

sms_provider_id
integer Nullable

the provider of the mobile phone number defined in smsalertnumber

privacy
integer

patron's privacy settings related to their reading history

privacy_guarantor_checkouts
integer

controls if relatives can see this patron's checkouts

privacy_guarantor_fines
boolean

controls if relatives can see this patron's fines

check_previous_checkout
string

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'

updated_on
string <date-time>

time of last change could be useful for synchronization with external systems (among others)

last_seen
string <date-time> Nullable

last time a patron has been seen (connected at the OPAC or staff interface)

lang
string

lang to use to send notices to this patron

login_attempts
integer Nullable

number of failed login attemps

overdrive_auth_token
string Nullable

persist OverDrive auth token

Responses

Request samples

Content type
application/json
{
  • "patron_id": 0,
  • "cardnumber": null,
  • "surname": null,
  • "firstname": null,
  • "title": "string",
  • "other_name": "string",
  • "initials": "string",
  • "street_number": "string",
  • "street_type": "string",
  • "address": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string",
  • "email": null,
  • "phone": null,
  • "mobile": "string",
  • "fax": "string",
  • "secondary_email": "string",
  • "secondary_phone": "string",
  • "altaddress_street_number": "string",
  • "altaddress_street_type": "string",
  • "altaddress_address": "string",
  • "altaddress_address2": "string",
  • "altaddress_city": "string",
  • "altaddress_state": "string",
  • "altaddress_postal_code": "string",
  • "altaddress_country": "string",
  • "altaddress_email": "string",
  • "altaddress_phone": "string",
  • "date_of_birth": "2019-08-24",
  • "library_id": "string",
  • "category_id": "string",
  • "date_enrolled": "2019-08-24",
  • "expiry_date": "2019-08-24",
  • "date_renewed": "string",
  • "incorrect_address": true,
  • "patron_card_lost": true,
  • "staff_notes": "string",
  • "relationship_type": "string",
  • "gender": "string",
  • "userid": "string",
  • "opac_notes": "string",
  • "altaddress_notes": "string",
  • "statistics_1": "string",
  • "statistics_2": "string",
  • "altcontact_firstname": "string",
  • "altcontact_surname": "string",
  • "altcontact_address": "string",
  • "altcontact_address2": "string",
  • "altcontact_city": "string",
  • "altcontact_state": "string",
  • "altcontact_postal_code": "string",
  • "altcontact_country": "string",
  • "altcontact_phone": "string",
  • "sms_number": "string",
  • "sms_provider_id": 0,
  • "privacy": 0,
  • "privacy_guarantor_checkouts": 0,
  • "privacy_guarantor_fines": true,
  • "check_previous_checkout": "string",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "last_seen": "2019-08-24T14:15:22Z",
  • "lang": "string",
  • "login_attempts": 0,
  • "overdrive_auth_token": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

deletePatron

path Parameters
patron_id
required
integer

Internal patron identifier

Responses

Response samples

Content type
application/json
{ }

checkouts

listCheckouts

query Parameters
patron_id
integer

Internal patron identifier

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

checked_in
boolean

By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "checkout_id": 0,
  • "patron_id": 0,
  • "item_id": 0,
  • "due_date": "2019-08-24T14:15:22Z",
  • "library_id": "string",
  • "checkin_date": "2019-08-24T14:15:22Z",
  • "last_renewed_date": "2019-08-24T14:15:22Z",
  • "renewals": 0,
  • "auto_renew": true,
  • "auto_renew_error": "string",
  • "timestamp": "string",
  • "checkout_date": "2019-08-24T14:15:22Z",
  • "onsite_checkout": true,
  • "note": "string",
  • "note_date": "2019-08-24"
}

renewCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "checkout_id": 0,
  • "patron_id": 0,
  • "item_id": 0,
  • "due_date": "2019-08-24T14:15:22Z",
  • "library_id": "string",
  • "checkin_date": "2019-08-24T14:15:22Z",
  • "last_renewed_date": "2019-08-24T14:15:22Z",
  • "renewals": 0,
  • "auto_renew": true,
  • "auto_renew_error": "string",
  • "timestamp": "string",
  • "checkout_date": "2019-08-24T14:15:22Z",
  • "onsite_checkout": true,
  • "note": "string",
  • "note_date": "2019-08-24"
}

allows_renewalCheckout

path Parameters
checkout_id
required
integer

Internal checkout identifier

Responses

Response samples

Content type
application/json
{
  • "allows_renewal": true,
  • "max_renewals": 0,
  • "current_renewals": 0,
  • "error": "string"
}

cities

listCities

query Parameters
name
string

Case insensative search on city name

state
string

Case insensative search on city state

country
string

Case insensative search on city country

postal_code
string

Case Insensative search on city postal code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addCity

Request Body schema: application/json

A JSON object containing informations about the new hold

name
required
string

city name

state
required
string Nullable

city state

postal_code
required
string Nullable

city postal code

country
required
string Nullable

city country

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "city_id": 0,
  • "name": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string"
}

getCity

path Parameters
city_id
required
integer

City internal identifier

Responses

Response samples

Content type
application/json
{
  • "city_id": 0,
  • "name": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string"
}

updateCity

path Parameters
city_id
required
integer

City internal identifier

Request Body schema: application/json

A city object

name
required
string

city name

state
required
string Nullable

city state

postal_code
required
string Nullable

city postal code

country
required
string Nullable

city country

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string"
}

Response samples

Content type
application/json
{
  • "city_id": 0,
  • "name": "string",
  • "state": "string",
  • "postal_code": "string",
  • "country": "string"
}

deleteCity

path Parameters
city_id
required
integer

City internal identifier

Responses

Response samples

Content type
application/json
"string"

biblios

getBiblio

path Parameters
biblio_id
required
integer

Record internal identifier

Responses

Response samples

Content type
{
  • "error": "string"
}

deleteBiblio

path Parameters
biblio_id
required
integer

Record internal identifier

Responses

Response samples

Content type
application/json
"string"

updateHoldPriority

path Parameters
hold_id
required
integer

Internal hold identifier

Request Body schema: application/json

An integer representing the new priority to be set for the hold

integer

Responses

Request samples

Content type
application/json
0

Response samples

Content type
application/json
0

getBiblioPublic

path Parameters
biblio_id
required
integer

Record internal identifier

Responses

Response samples

Content type
No sample

holds

addClubHold

path Parameters
club_id
required
integer

Internal club identifier

Request Body schema: application/json

A JSON object containing informations about the new hold

biblio_id
integer Nullable

Internal biblio identifier

item_id
integer Nullable

Internal item identifier

pickup_library_id
required
string

Internal library identifier for the pickup library

expiration_date
string <date> Nullable

Hold end date

notes
string Nullable

Notes related to this hold

item_type
string Nullable

Limit hold on one itemtype (ignored for item-level holds)

Responses

Request samples

Content type
application/json
{
  • "biblio_id": 0,
  • "item_id": 0,
  • "pickup_library_id": "string",
  • "expiration_date": "2019-08-24",
  • "notes": "string",
  • "item_type": "string"
}

Response samples

Content type
application/json
{
  • "club_hold_id": 0,
  • "club_id": 0,
  • "biblio_id": 0,
  • "item_id": "string"
}

listHolds

query Parameters
hold_id
integer

Internal reserve identifier

patron_id
integer

Internal patron identifier

hold_date
string <date>

Hold

biblio_id
integer

Internal biblio identifier

pickup_library_id
string

Internal library identifier for the pickup library

cancellation_date
string <date>

The date the hold was cancelled

notes
string

Notes related to this hold

priority
integer

Where in the queue the patron sits

status
string

Found status

timestamp
string

Time of latest update

item_id
integer

Internal item identifier

waiting_date
string

Date the item was marked as waiting for the patron

expiration_date
string

Date the hold expires

lowest_priority
boolean

Lowest priority

suspended
boolean

Suspended

suspended_until
string

Suspended until

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addHold

Request Body schema: application/json

A JSON object containing informations about the new hold

patron_id
required
integer

Internal patron identifier

biblio_id
integer Nullable

Internal biblio identifier

item_id
integer Nullable

Internal item identifier

pickup_library_id
required
string

Internal library identifier for the pickup library

expiration_date
string <date> Nullable

Hold end date

notes
string Nullable

Notes related to this hold

item_type
string Nullable

Limit hold on one itemtype (ignored for item-level holds)

Responses

Request samples

Content type
application/json
{
  • "patron_id": 0,
  • "biblio_id": 0,
  • "item_id": 0,
  • "pickup_library_id": "string",
  • "expiration_date": "2019-08-24",
  • "notes": "string",
  • "item_type": "string"
}

Response samples

Content type
application/json
{
  • "hold_id": 0,
  • "patron_id": 0,
  • "hold_date": "2019-08-24",
  • "biblio_id": 0,
  • "pickup_library_id": "string",
  • "cancellation_date": "2019-08-24",
  • "notes": "string",
  • "priority": 0,
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "item_id": "string",
  • "waiting_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "lowest_priority": true,
  • "suspended": true,
  • "suspended_until": "2019-08-24T14:15:22Z",
  • "item_type": "string",
  • "item_level": true
}

editHold

path Parameters
hold_id
required
integer

Internal hold identifier

Request Body schema: application/json

A JSON object containing fields to modify

priority
integer >= 1

Position in waiting queue

branchcode
string

Pickup location

suspend_until
string <date>

Suspend until

Responses

Request samples

Content type
application/json
{
  • "priority": 1,
  • "branchcode": "string",
  • "suspend_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "hold_id": 0,
  • "patron_id": 0,
  • "hold_date": "2019-08-24",
  • "biblio_id": 0,
  • "pickup_library_id": "string",
  • "cancellation_date": "2019-08-24",
  • "notes": "string",
  • "priority": 0,
  • "status": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "item_id": "string",
  • "waiting_date": "2019-08-24",
  • "expiration_date": "2019-08-24",
  • "lowest_priority": true,
  • "suspended": true,
  • "suspended_until": "2019-08-24T14:15:22Z",
  • "item_type": "string",
  • "item_level": true
}

deleteHold

path Parameters
hold_id
required
integer

Internal hold identifier

Responses

Response samples

Content type
application/json
{ }

updateHoldPriority

path Parameters
hold_id
required
integer

Internal hold identifier

Request Body schema: application/json

An integer representing the new priority to be set for the hold

integer

Responses

Request samples

Content type
application/json
0

Response samples

Content type
application/json
0

suspendHold

path Parameters
hold_id
required
integer

Internal hold identifier

Request Body schema: application/json

A JSON object containing fields to modify

end_date
string <date>

Date the hold suspension expires

Responses

Request samples

Content type
application/json
{
  • "end_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

resumeHold

path Parameters
hold_id
required
integer

Internal hold identifier

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

clubs

addClubHold

path Parameters
club_id
required
integer

Internal club identifier

Request Body schema: application/json

A JSON object containing informations about the new hold

biblio_id
integer Nullable

Internal biblio identifier

item_id
integer Nullable

Internal item identifier

pickup_library_id
required
string

Internal library identifier for the pickup library

expiration_date
string <date> Nullable

Hold end date

notes
string Nullable

Notes related to this hold

item_type
string Nullable

Limit hold on one itemtype (ignored for item-level holds)

Responses

Request samples

Content type
application/json
{
  • "biblio_id": 0,
  • "item_id": 0,
  • "pickup_library_id": "string",
  • "expiration_date": "2019-08-24",
  • "notes": "string",
  • "item_type": "string"
}

Response samples

Content type
application/json
{
  • "club_hold_id": 0,
  • "club_id": 0,
  • "biblio_id": 0,
  • "item_id": "string"
}

items

listItems

query Parameters
external_id
string

Search on the item's barcode

_match
string
Enum: "contains" "exact" "starts_with" "ends_with"

Matching criteria

_order_by
Array of strings

Sorting criteria

_page
integer

Page number, for paginated object listing

_per_page
integer

Page size, for paginated object listing

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getItem

path Parameters
item_id
required
integer

Internal item identifier

Responses

Response samples

Content type
application/json
{
  • "item_id": 0,
  • "biblio_id": 0,
  • "external_id": "string",
  • "acquisition_date": "2019-08-24",
  • "acquisition_source": "string",
  • "home_library_id": "string",
  • "purchase_price": 0,
  • "replacement_price": 0,
  • "replacement_price_date": "2019-08-24",
  • "last_checkout_date": "2019-08-24",
  • "last_seen_date": "2019-08-24",
  • "not_for_loan_status": 0,
  • "damaged_status": 0,
  • "damaged_date": "string",
  • "lost_status": 0,
  • "lost_date": "2019-08-24T14:15:22Z",
  • "withdrawn": 0,
  • "withdrawn_date": "2019-08-24T14:15:22Z",
  • "callnumber": "string",
  • "coded_location_qualifier": "string",
  • "checkouts_count": 0,
  • "renewals_count": 0,
  • "holds_count": 0,
  • "restricted_status": 0,
  • "public_notes": "string",
  • "internal_notes": "string",
  • "holding_library_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "location": "string",
  • "permanent_location": "string",
  • "checked_out_date": "2019-08-24",
  • "call_number_source": "string",
  • "call_number_sort": "string",
  • "collection_code": "string",
  • "materials_notes": "string",
  • "uri": "string",
  • "item_type": "string",
  • "extended_subfields": "string",
  • "serial_issue_number": "string",
  • "copy_number": "string",
  • "inventory_number": "string",
  • "new_status": "string"
}

library

listLibrary

query Parameters
name
string

Case insensitive 'starts-with' search on name

address1
string

Case insensitive 'starts-with' search on address1

address2
string

Case insensitive 'starts-with' search on address2

address3
string

Case insensitive 'starts-with' search on address3

postal_code
string

Case insensitive 'starts-with' search on postal code

city
string

Case insensitive 'starts-with' search on city

state
string

Case insensitive 'starts-with' search on state

country
string

Case insensitive 'starts_with' search on country

phone
string

Case insensitive 'starts_with' search on phone number

fax
string

Case insensitive 'starts_with' search on fax number

email
string

Case insensitive 'starts_with' search on email address

reply_to_email
string

Case insensitive 'starts_with' search on Reply-To email address

return_path_email
string

Case insensitive 'starts_with' search on Return-Path email address

url
string

Case insensitive 'starts_with' search on website URL

ip
string

Case insensitive 'starts_with' search on IP address

notes
string

Case insensitive 'starts_with' search on notes

opac_info
string

Case insensitive 'starts-with' search on OPAC info

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addLibrary

Request Body schema: application/json

A JSON object containing informations about the new library

library_id
required
string [ 1 .. 10 ] characters

internally assigned library identifier

name
required
string

Printable name of library

address1
string Nullable

the first address line of the library

address2
string Nullable

the second address line of the library

address3
string Nullable

the third address line of the library

postal_code
string Nullable

the postal code of the library

city
string Nullable

the city or province of the library

state
string Nullable

the reqional state of the library

country
string Nullable

the county of the library

phone
string Nullable

the primary phone of the library

fax
string Nullable

the fax number of the library

email
string Nullable

the primary email address of the library

reply_to_email
string Nullable

the email to be used as a Reply-To

return_path_email
string Nullable

the email to be used as Return-Path

url
string Nullable

the URL for your library or branch's website

ip
string Nullable

the IP address for your library or branch

notes
string Nullable

notes related to your library or branch

opac_info
string Nullable

HTML that displays in OPAC

geolocation
string Nullable

geolocation of your library

marc_org_code
string Nullable

MARC Organization Code, see http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults to syspref MARCOrgCode

pickup_location
boolean

If the library can act as a pickup location

Responses

Request samples

Content type
application/json
{
  • "library_id": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "reply_to_email": "string",
  • "return_path_email": "string",
  • "url": "string",
  • "ip": "string",
  • "notes": "string",
  • "opac_info": "string",
  • "geolocation": "string",
  • "marc_org_code": "string",
  • "pickup_location": true
}

Response samples

Content type
application/json
{
  • "library_id": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "reply_to_email": "string",
  • "return_path_email": "string",
  • "url": "string",
  • "ip": "string",
  • "notes": "string",
  • "opac_info": "string",
  • "geolocation": "string",
  • "marc_org_code": "string",
  • "pickup_location": true
}

getLibrary

path Parameters
library_id
required
string

Internal library identifier

Responses

Response samples

Content type
application/json
{
  • "library_id": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "reply_to_email": "string",
  • "return_path_email": "string",
  • "url": "string",
  • "ip": "string",
  • "notes": "string",
  • "opac_info": "string",
  • "geolocation": "string",
  • "marc_org_code": "string",
  • "pickup_location": true
}

updateLibrary

path Parameters
library_id
required
string

Internal library identifier

Request Body schema: application/json

A JSON object containing information on the library

library_id
required
string [ 1 .. 10 ] characters

internally assigned library identifier

name
required
string

Printable name of library

address1
string Nullable

the first address line of the library

address2
string Nullable

the second address line of the library

address3
string Nullable

the third address line of the library

postal_code
string Nullable

the postal code of the library

city
string Nullable

the city or province of the library

state
string Nullable

the reqional state of the library

country
string Nullable

the county of the library

phone
string Nullable

the primary phone of the library

fax
string Nullable

the fax number of the library

email
string Nullable

the primary email address of the library

reply_to_email
string Nullable

the email to be used as a Reply-To

return_path_email
string Nullable

the email to be used as Return-Path

url
string Nullable

the URL for your library or branch's website

ip
string Nullable

the IP address for your library or branch

notes
string Nullable

notes related to your library or branch

opac_info
string Nullable

HTML that displays in OPAC

geolocation
string Nullable

geolocation of your library

marc_org_code
string Nullable

MARC Organization Code, see http://www.loc.gov/marc/organizations/orgshome.html, when empty defaults to syspref MARCOrgCode

pickup_location
boolean

If the library can act as a pickup location

Responses

Request samples

Content type
application/json
{
  • "library_id": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "reply_to_email": "string",
  • "return_path_email": "string",
  • "url": "string",
  • "ip": "string",
  • "notes": "string",
  • "opac_info": "string",
  • "geolocation": "string",
  • "marc_org_code": "string",
  • "pickup_location": true
}

Response samples

Content type
application/json
{
  • "library_id": "string",
  • "name": "string",
  • "address1": "string",
  • "address2": "string",
  • "address3": "string",
  • "postal_code": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "reply_to_email": "string",
  • "return_path_email": "string",
  • "url": "string",
  • "ip": "string",
  • "notes": "string",
  • "opac_info": "string",
  • "geolocation": "string",
  • "marc_org_code": "string",
  • "pickup_location": true
}

deleteLibrary

path Parameters
library_id
required
string

Internal library identifier

Responses

Response samples

Content type
application/json
"string"

patron

getPatronAccount

path Parameters
patron_id
required
integer

Internal patron identifier

Responses

Response samples

Content type
application/json
{
  • "balance": 0,
  • "outstanding_credits": {
    },
  • "outstanding_debits": {
    }
}

addPatronCredit

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A JSON object containing credit information

credit_type
string

Type of credit ('CREDIT', 'FORGIVEN', 'LOST_RETURN', 'PAYMENT', 'WRITEOFF' )

amount
required
number >= 0

Credit amount

library_id
string Nullable

Internal identifier for the library in which the transaction took place

account_lines_ids
Array of integers

List of account line ids the credit goes against (optional)

payment_type
string

Payment type (only applies when credit_type=payment)

date
string <date>

Date the credit was recorded (optional)

description
string

Description

note
string

Internal note

Responses

Request samples

Content type
application/json
{
  • "credit_type": "string",
  • "amount": 0,
  • "library_id": "string",
  • "account_lines_ids": [
    ],
  • "payment_type": "string",
  • "date": "2019-08-24",
  • "description": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{ }

setPatronPassword

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A JSON object containing password information

password
required
string

New password (plain text)

password_2
required
string

Repeated new password (plain text)

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "password_2": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

setPatronPasswordPublic

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A JSON object containing password information

password
required
string

New password (plain text)

password_repeated
required
string

Repeated new password (plain text)

old_password
required
string

Patron's original password

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "password_repeated": "string",
  • "old_password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

setPatronGuarantorsCanSeeCharges

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A boolean representing if guarantors should be able to see the patron's charges

allowed
boolean

Responses

Request samples

Content type
application/json
{
  • "allowed": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

setPatronGuarantorsCanSeeCheckouts

path Parameters
patron_id
required
integer

Internal patron identifier

Request Body schema: application/json

A boolean representing if guarantors should be able to see the patron's checkouts

allowed
boolean

Responses

Request samples

Content type
application/json
{
  • "allowed": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

illrequests

listIllrequests

query Parameters
embed
Array of strings
Items Enum: "patron" "library" "capabilities" "metadata" "requested_partners" "comments" "status_alias"

Additional objects that should be embedded in the response

backend
string

The name of a ILL backend

orderid
string

The order ID of a request

biblionumber
integer

Internal biblio identifier

borrowernumber
integer

Internal patron identifier

completed
string

The date the request was considered completed

completed_formatted
string

The date the request was considered complete formatted

status
string

A full status string e.g. REQREV

cost
number

The quoted cost of the request

price_paid
number

The final cost of the request

medium
string

The medium of the requested item

updated
string

The last updated date of the request

updated_formatted
string

The last updated date of the request formatted

placed
string

The date the request was placed

placed_formatted
string

The date the request was placed formatted

branchcode
string

Library ID

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

rotas

moveStage

path Parameters
rota_id
required
integer

A rotas ID

stage_id
required
integer

A stages ID

Request Body schema: application/json

A stages position in the rota

integer

Responses

Request samples

Content type
application/json
0

Response samples

Content type
application/json
{
  • "error": "string"
}

claims

claimReturned

Request Body schema: application/json

A JSON object containing fields to modify

item_id
integer

Internal item id to claim as returned

notes
string

Notes about this return claim

created_by
string

User id for the librarian submitting this claim

charge_lost_fee
boolean

Charge a lost fee if true and Koha is set to allow a choice. Ignored otherwise.

Responses

Request samples

Content type
application/json
{
  • "item_id": 0,
  • "notes": "string",
  • "created_by": "string",
  • "charge_lost_fee": true
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

updateClaimNotes

path Parameters
claim_id
required
integer

Unique identifier for the claim whose notes are to be updated

Request Body schema: application/json

A JSON object containing fields to modify

notes
string

Notes about this return claim

updated_by
string

Interal identifier for the librarian updating the claim notes

Responses

Request samples

Content type
application/json
{
  • "notes": "string",
  • "updated_by": "string"
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

updateClaimResolve

path Parameters
claim_id
required
integer

Unique identifier for the claim to be resolved

Request Body schema: application/json

A JSON object containing fields to modify

resolution
string

The RETURN_CLAIM_RESOLUTION code to be used to resolve the calim

resolved_by
string

User id for the librarian resolving the claim

Responses

Request samples

Content type
application/json
{
  • "resolution": "string",
  • "resolved_by": "string"
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

deletedClaim

path Parameters
claim_id
required
integer

Unique identifier for the claim to be deleted

Responses

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

returned

claimReturned

Request Body schema: application/json

A JSON object containing fields to modify

item_id
integer

Internal item id to claim as returned

notes
string

Notes about this return claim

created_by
string

User id for the librarian submitting this claim

charge_lost_fee
boolean

Charge a lost fee if true and Koha is set to allow a choice. Ignored otherwise.

Responses

Request samples

Content type
application/json
{
  • "item_id": 0,
  • "notes": "string",
  • "created_by": "string",
  • "charge_lost_fee": true
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

updateClaimNotes

path Parameters
claim_id
required
integer

Unique identifier for the claim whose notes are to be updated

Request Body schema: application/json

A JSON object containing fields to modify

notes
string

Notes about this return claim

updated_by
string

Interal identifier for the librarian updating the claim notes

Responses

Request samples

Content type
application/json
{
  • "notes": "string",
  • "updated_by": "string"
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

updateClaimResolve

path Parameters
claim_id
required
integer

Unique identifier for the claim to be resolved

Request Body schema: application/json

A JSON object containing fields to modify

resolution
string

The RETURN_CLAIM_RESOLUTION code to be used to resolve the calim

resolved_by
string

User id for the librarian resolving the claim

Responses

Request samples

Content type
application/json
{
  • "resolution": "string",
  • "resolved_by": "string"
}

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

deletedClaim

path Parameters
claim_id
required
integer

Unique identifier for the claim to be deleted

Responses

Response samples

Content type
application/json
{
  • "claim_id": 0,
  • "item_id": 0,
  • "issue_id": 0,
  • "old_issue_id": 0,
  • "patron_id": 0,
  • "notes": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "created_by": 0,
  • "updated_on": "2019-08-24T14:15:22Z",
  • "updated_by": 0,
  • "resolution": "string",
  • "resolved_on": "2019-08-24T14:15:22Z",
  • "resolved_by": 0
}

return

claimReturned

Request Body schema: application/json

A JSON object containing fields to modify

item_id
integer

Internal item id to claim as returned

notes
string

Notes about this return claim

created_by
string

User id for the librarian submitting this claim

charge_lost_fee
boolean

Charge a lost fee if true and Koha is set to allow a choice. Ignored otherwise.

Responses

Request samples

Content type
application/json