4 "title": "Koha REST API",
8 "url": "http://www.gnu.org/licenses/gpl.txt"
12 "url": "http://koha-community.org/"
15 "basePath": "/api/v1",
19 "operationId": "listPatrons",
26 "description": "A list of patrons",
30 "$ref": "#/definitions/patron"
35 "description": "Access forbidden",
37 "$ref": "#/definitions/error"
43 "/patrons/{borrowernumber}": {
45 "operationId": "getPatron",
49 "$ref": "#/parameters/borrowernumberPathParam"
57 "description": "A patron",
59 "$ref": "#/definitions/patron"
63 "description": "Access forbidden",
65 "$ref": "#/definitions/error"
69 "description": "Patron not found",
71 "$ref": "#/definitions/error"
79 "operationId": "listHolds",
80 "tags": ["borrowers", "holds"],
83 "name": "borrowernumber",
85 "description": "Internal borrower identifier",
90 "produces": ["application/json"],
93 "description": "A list of holds",
94 "schema": { "$ref": "#/definitions/holds" }
97 "description": "Borrower not found",
98 "schema": { "$ref": "#/definitions/error" }
103 "operationId": "addHold",
104 "tags": ["borrowers", "holds"],
109 "description": "A JSON object containing informations about the new hold",
115 "description": "Borrower internal identifier",
119 "description": "Biblio internal identifier",
123 "description": "Item internal identifier",
127 "description": "Pickup location",
131 "description": "Hold end date",
139 "consumes": ["application/json"],
140 "produces": ["application/json"],
143 "description": "Created hold",
144 "schema": { "$ref": "#/definitions/hold" }
147 "description": "Missing or wrong parameters",
148 "schema": { "$ref": "#/definitions/error" }
151 "description": "Hold not allowed",
152 "schema": { "$ref": "#/definitions/error" }
155 "description": "Borrower not found",
156 "schema": { "$ref": "#/definitions/error" }
159 "description": "Internal error",
160 "schema": { "$ref": "#/definitions/error" }
165 "/holds/{reserve_id}": {
167 "operationId": "editHold",
170 { "$ref": "#/parameters/holdIdPathParam" },
174 "description": "A JSON object containing fields to modify",
180 "description": "Position in waiting queue",
185 "description": "Pickup location",
189 "description": "Suspend until",
197 "consumes": ["application/json"],
198 "produces": ["application/json"],
201 "description": "Updated hold",
202 "schema": { "$ref": "#/definitions/hold" }
205 "description": "Missing or wrong parameters",
206 "schema": { "$ref": "#/definitions/error" }
209 "description": "Hold not found",
210 "schema": { "$ref": "#/definitions/error" }
215 "operationId": "deleteHold",
218 { "$ref": "#/parameters/holdIdPathParam" }
220 "produces": ["application/json"],
223 "description": "Successful deletion",
229 "description": "Hold not found",
230 "schema": { "$ref": "#/definitions/error" }
237 "$ref": "./definitions/index.json"
240 "borrowernumberPathParam": {
241 "name": "borrowernumber",
243 "description": "Internal patron identifier",
248 "name": "reserve_id",
250 "description": "Internal hold identifier",