975be0aef0
borrowernumber parameter is no longer required and you can filter on every column of reserves table Some example requests - GET /api/v1/holds - GET /api/v1/holds?biblionumber=123 - GET /api/v1/holds?borrowernumber=456 - GET /api/v1/holds?priority=0&found=W Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
356 lines
9.5 KiB
JSON
356 lines
9.5 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Koha REST API",
|
|
"version": "1",
|
|
"license": {
|
|
"name": "GPL v3",
|
|
"url": "http://www.gnu.org/licenses/gpl.txt"
|
|
},
|
|
"contact": {
|
|
"name": "Koha Team",
|
|
"url": "http://koha-community.org/"
|
|
}
|
|
},
|
|
"basePath": "/api/v1",
|
|
"paths": {
|
|
"/patrons": {
|
|
"get": {
|
|
"operationId": "listPatrons",
|
|
"tags": ["patrons"],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of patrons",
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/patron"
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/patrons/{borrowernumber}": {
|
|
"get": {
|
|
"operationId": "getPatron",
|
|
"tags": ["patrons"],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/parameters/borrowernumberPathParam"
|
|
}
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A patron",
|
|
"schema": {
|
|
"$ref": "#/definitions/patron"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Access forbidden",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Patron not found",
|
|
"schema": {
|
|
"$ref": "#/definitions/error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/holds": {
|
|
"get": {
|
|
"operationId": "listHolds",
|
|
"tags": ["borrowers", "holds"],
|
|
"parameters": [
|
|
{
|
|
"name": "reserve_id",
|
|
"in": "query",
|
|
"description": "Internal reserve identifier",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "borrowernumber",
|
|
"in": "query",
|
|
"description": "Internal borrower identifier",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "reservedate",
|
|
"in": "query",
|
|
"description": "Reserve date",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "biblionumber",
|
|
"in": "query",
|
|
"description": "Internal biblio identifier",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "branchcode",
|
|
"in": "query",
|
|
"description": "Branch code",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "notificationdate",
|
|
"in": "query",
|
|
"description": "Notification date",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "reminderdate",
|
|
"in": "query",
|
|
"description": "Reminder date",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "cancellationdate",
|
|
"in": "query",
|
|
"description": "Cancellation date",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "reservenotes",
|
|
"in": "query",
|
|
"description": "Reserve notes",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "priority",
|
|
"in": "query",
|
|
"description": "Priority",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "found",
|
|
"in": "query",
|
|
"description": "Found status",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "timestamp",
|
|
"in": "query",
|
|
"description": "Time of latest update",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "itemnumber",
|
|
"in": "query",
|
|
"description": "Internal item identifier",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "waitingdate",
|
|
"in": "query",
|
|
"description": "Date the item was marked as waiting for the patron",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "expirationdate",
|
|
"in": "query",
|
|
"description": "Date the hold expires",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "lowestPriority",
|
|
"in": "query",
|
|
"description": "Lowest priority",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "suspend",
|
|
"in": "query",
|
|
"description": "Suspended",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "suspend_until",
|
|
"in": "query",
|
|
"description": "Suspended until",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "A list of holds",
|
|
"schema": { "$ref": "#/definitions/holds" }
|
|
},
|
|
"404": {
|
|
"description": "Borrower not found",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"operationId": "addHold",
|
|
"tags": ["borrowers", "holds"],
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"description": "A JSON object containing informations about the new hold",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"borrowernumber": {
|
|
"description": "Borrower internal identifier",
|
|
"type": "integer"
|
|
},
|
|
"biblionumber": {
|
|
"description": "Biblio internal identifier",
|
|
"type": "integer"
|
|
},
|
|
"itemnumber": {
|
|
"description": "Item internal identifier",
|
|
"type": "integer"
|
|
},
|
|
"branchcode": {
|
|
"description": "Pickup location",
|
|
"type": "string"
|
|
},
|
|
"expirationdate": {
|
|
"description": "Hold end date",
|
|
"type": "string",
|
|
"format": "date"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"consumes": ["application/json"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created hold",
|
|
"schema": { "$ref": "#/definitions/hold" }
|
|
},
|
|
"400": {
|
|
"description": "Missing or wrong parameters",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
},
|
|
"403": {
|
|
"description": "Hold not allowed",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
},
|
|
"404": {
|
|
"description": "Borrower not found",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
},
|
|
"500": {
|
|
"description": "Internal error",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/holds/{reserve_id}": {
|
|
"put": {
|
|
"operationId": "editHold",
|
|
"tags": ["holds"],
|
|
"parameters": [
|
|
{ "$ref": "#/parameters/holdIdPathParam" },
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"description": "A JSON object containing fields to modify",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"priority": {
|
|
"description": "Position in waiting queue",
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"branchcode": {
|
|
"description": "Pickup location",
|
|
"type": "string"
|
|
},
|
|
"suspend_until": {
|
|
"description": "Suspend until",
|
|
"type": "string",
|
|
"format": "date"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"consumes": ["application/json"],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Updated hold",
|
|
"schema": { "$ref": "#/definitions/hold" }
|
|
},
|
|
"400": {
|
|
"description": "Missing or wrong parameters",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
},
|
|
"404": {
|
|
"description": "Hold not found",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "deleteHold",
|
|
"tags": ["holds"],
|
|
"parameters": [
|
|
{ "$ref": "#/parameters/holdIdPathParam" }
|
|
],
|
|
"produces": ["application/json"],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful deletion",
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Hold not found",
|
|
"schema": { "$ref": "#/definitions/error" }
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"$ref": "./definitions/index.json"
|
|
},
|
|
"parameters": {
|
|
"borrowernumberPathParam": {
|
|
"name": "borrowernumber",
|
|
"in": "path",
|
|
"description": "Internal patron identifier",
|
|
"required": true,
|
|
"type": "integer"
|
|
},
|
|
"holdIdPathParam": {
|
|
"name": "reserve_id",
|
|
"in": "path",
|
|
"description": "Internal hold identifier",
|
|
"required": true,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|