Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Indian Institute of Technology Kanpur

Indian Institute of Technology Kanpur patrons API

Manage patrons

Documentation Provider Profile APIs.io OpenAPI GitHub

Indian Institute of Technology Kanpur patrons API is one of 64 APIs that Indian Institute of Technology Kanpur publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include patrons. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 16 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://libserv.iitk.ac.in/api/v1.

24 operations 16 paths 10 schemas 3 DELETE6 GET1 PATCH9 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://libserv.iitk.ac.in/cgi-bin/koha/oai.pl
Contact
Koha Development Team
License
GPL v3,
Resource Areas
1

Paths & Operations 24

Across 16 paths, the API surfaces 24 operations — 3 DELETE, 6 GET, 1 PATCH, 9 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

patrons 24

Manage patrons

POST
/auth/password/validation
Check validity of username and password
validateUserAndPassword body → 201400401403404500501503
POST
/checkouts
Add a new checkout
addCheckout 1 param body → 201400401403404409412500
GET
/patrons
List patrons
listPatrons 74 params body → 200400401403404500501503
POST
/patrons
Add patron
addPatron 1 param body → 201400401403404409500501
DELETE
/patrons/{patron_id}
Delete patron
deletePatron 1 param → 204400401403404409500501
GET
/patrons/{patron_id}
Get patron
getPatron 2 params → 200400401403404500501503
PUT
/patrons/{patron_id}
Update patron
updatePatron 1 param body → 200400401403404409500501
GET
/patrons/{patron_id}/account
Get account information for a patron
getPatronAccount 1 param → 200400401403404500501503
GET
/patrons/{patron_id}/account/credits
List patron credits
listPatronCredits 6 params body → 200400401403404500501503
POST
/patrons/{patron_id}/account/credits
Add credit to a patron's account
addPatronCredit 1 param body → 201400401403404500501503
GET
/patrons/{patron_id}/account/debits
List patron debits
listPatronDebits 6 params body → 200400401403404500501503
POST
/patrons/{patron_id}/account/debits
Add debit to a patron's account
addPatronDebit 1 param body → 201400401403404500501503
GET
/patrons/{patron_id}/extended_attributes
List extended attributes for a patron
getPatronAttributes 7 params body → 200400401403404500501503
POST
/patrons/{patron_id}/extended_attributes
Add extended attribute for a patron
addPatronAttribute 1 param body → 201400401403404409500501
PUT
/patrons/{patron_id}/extended_attributes
Overwrite extended attributes for a patron
overwritePatronAttributes 1 param body → 200400401403404409500501
DELETE
/patrons/{patron_id}/extended_attributes/{extended_attribute_id}
Delete extended attribute
deletePatronAttribute 2 params → 204400401403404500501503
PATCH
/patrons/{patron_id}/extended_attributes/{extended_attribute_id}
Update extended attribute
updatePatronAttribute 2 params body → 200400401403404409500501
POST
/patrons/{patron_id}/password
Set password for a patron
setPatronPassword 1 param body → 200400401403404500501503
PUT
/patrons/{patron_id}/password/expiration_date
Set password expiration for a patron
setPatronPasswordExpiration 1 param body → 200400401403404500501503
POST
/public/patrons/{patron_id}/checkouts
Add a new checkout (public)
addCheckoutPublic 2 params body → 201400401403404405409412
PUT
/public/patrons/{patron_id}/guarantors/can_see_charges
Set if guarantors can see charges (public)
setPatronGuarantorsCanSeeCharges 1 param body → 200400401403404500501503
PUT
/public/patrons/{patron_id}/guarantors/can_see_checkouts
Set if guarantors can see checkouts
setPatronGuarantorsCanSeeCheckouts 1 param body → 200400401403404500501503
DELETE
/public/patrons/{patron_id}/holds/{hold_id}
Cancel a patron's hold (public)
cancelPatronHoldPublic 2 params → 202204400401403404500501
POST
/public/patrons/{patron_id}/password
Set password for a patron (public)
setPatronPasswordPublic 1 param body → 200400401403404500501503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are patron_yaml (79 properties), checkout_yaml (22 properties), account_line_yaml (20 properties), debit_yaml (17 properties). Each schema is shown below with its type and property counts.

debit_yaml
object
17 properties 1 required
error_yaml
object
2 properties
account_line_yaml
object
20 properties 1 required
checkout_yaml
object
22 properties
patron_account_credit_yaml
object
8 properties 1 required
patron_yaml
object
79 properties 3 required
patron_extended_attribute_yaml
object
3 properties 2 required
patron_balance_yaml
object
3 properties 1 required
DefaultResponse
object
1 property 1 required
credit_yaml
object
16 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iit-kanpur-patrons-api-openapi.yml Raw ↑

Other APIs Indian Institute of Technology Kanpur publishes across the network.

Indian Institute of Technology Kanpur 2fa API
AE Profile APIs.io
Indian Institute of Technology Kanpur article_requests API
AE Profile APIs.io
Indian Institute of Technology Kanpur authorised_value_categories API
AE Profile APIs.io
Indian Institute of Technology Kanpur authorised_values API
AE Profile APIs.io
Indian Institute of Technology Kanpur authorities API
AE Profile APIs.io
Indian Institute of Technology Kanpur baskets API
AE Profile APIs.io
Indian Institute of Technology Kanpur batch_import_profiles API
AE Profile APIs.io
Indian Institute of Technology Kanpur biblios API
AE Profile APIs.io
Indian Institute of Technology Kanpur bookings API
AE Profile APIs.io
Indian Institute of Technology Kanpur cash_registers API
AE Profile APIs.io
Indian Institute of Technology Kanpur cashups API
AE Profile APIs.io
Indian Institute of Technology Kanpur checkouts API
AE Profile APIs.io
#patrons
← Back to I APIs
API Details
ID
iit-kanpur:iit-kanpur-patrons-api
Base URL
https://libserv.iitk.ac.in/cgi-bin/koha/oai.pl
Docs
https://libserv.iitk.ac.in/
Provider
Indian Institute of Technology Kanpur
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network