Koha/api/v1/swagger/paths/illrequests.json
Alex Sassmannshausen 8e86b5e093 Bug 7317: Interlibrary loans framework for Koha.
This Commit is at the heart of adding an interlibrary loans framework
for Koha.  The framework does not prescribe a particular workflow.
Instead it provides a general framework that can be extended &
implemented by individual backends whose responsibility it is to
implement a specific workflow.

The module is largely self-sufficient: it adds new tables to the Koha
database and touches only a few files in the Koha source tree.

Primarily, we add our files to the Makefile and the koha-conf.xml,
define ill paths for the REST API, and introduce links from the main
intranet, opac pages & user permissions.

Outside of this we simply add new files & functionality.

Signed-off-by: Magnus Enger <magnus@libriotech.no>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2017-11-09 11:42:12 -03:00

98 lines
3.2 KiB
JSON

{
"/illrequests": {
"get": {
"x-mojo-controller": "Koha::REST::V1::Illrequests",
"operationId": "list",
"tags": ["illrequests"],
"parameters": [{
"name": "embed",
"in": "query",
"description": "Additional objects that should be embedded in the response",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": [
"patron",
"branch",
"capabilities"
]
}
}, {
"name": "backend",
"in": "query",
"description": "The name of a ILL backend",
"required": false,
"type": "string"
}, {
"name": "orderid",
"in": "query",
"description": "The order ID of a request",
"required": false,
"type": "string"
}, {
"name": "biblio_id",
"in": "query",
"description": "The biblio ID associated with a request",
"required": false,
"type": "integer"
}, {
"name": "borrower_id",
"in": "query",
"description": "The borrower ID associated with a request",
"required": false,
"type": "integer"
}, {
"name": "completed",
"in": "query",
"description": "The date the request was considered completed",
"required": false,
"type": "string"
}, {
"name": "status",
"in": "query",
"description": "A full status string e.g. REQREV",
"required": false,
"type": "string"
}, {
"name": "medium",
"in": "query",
"description": "The medium of the requested item",
"required": false,
"type": "string"
}, {
"name": "updated",
"in": "query",
"description": "The last updated date of the request",
"required": false,
"type": "string"
}, {
"name": "placed",
"in": "query",
"description": "The date the request was placed",
"required": false,
"type": "string"
}, {
"name": "branch_id",
"in": "query",
"description": "The ID of the pickup branch",
"required": false,
"type": "string"
}],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK"
}
},
"x-koha-authorization": {
"permissions": {
"borrowers": "1"
}
}
}
}
}