Bug 7317: (QA followup) Make query parameters consistent with other endpoints
[koha.git] / api / v1 / swagger / paths / illrequests.json
1 {
2     "/illrequests": {
3         "get": {
4             "x-mojo-to": "Illrequests#list",
5             "operationId": "listIllrequests",
6             "tags": ["illrequests"],
7             "parameters": [{
8                 "name": "embed",
9                 "in": "query",
10                 "description": "Additional objects that should be embedded in the response",
11                 "required": false,
12                 "type": "array",
13                 "collectionFormat": "csv",
14                 "items": {
15                     "type": "string",
16                     "enum": [
17                         "patron",
18                         "library",
19                         "capabilities",
20                         "metadata"
21                     ]
22                 }
23             }, {
24                 "name": "backend",
25                 "in": "query",
26                 "description": "The name of a ILL backend",
27                 "required": false,
28                 "type": "string"
29             }, {
30                 "name": "orderid",
31                 "in": "query",
32                 "description": "The order ID of a request",
33                 "required": false,
34                 "type": "string"
35             }, {
36                 "name": "biblionumber",
37                 "in": "query",
38                 "description": "Internal biblio identifier",
39                 "required": false,
40                 "type": "integer"
41             }, {
42                 "$ref": "../parameters.json#/borrowernumberQueryParam"
43             }, {
44                 "name": "completed",
45                 "in": "query",
46                 "description": "The date the request was considered completed",
47                 "required": false,
48                 "type": "string"
49             }, {
50                 "name": "status",
51                 "in": "query",
52                 "description": "A full status string e.g. REQREV",
53                 "required": false,
54                 "type": "string"
55             }, {
56                 "name": "medium",
57                 "in": "query",
58                 "description": "The medium of the requested item",
59                 "required": false,
60                 "type": "string"
61             }, {
62                 "name": "updated",
63                 "in": "query",
64                 "description": "The last updated date of the request",
65                 "required": false,
66                 "type": "string"
67             }, {
68                 "name": "placed",
69                 "in": "query",
70                 "description": "The date the request was placed",
71                 "required": false,
72                 "type": "string"
73             }, {
74                 "name": "branchcode",
75                 "in": "query",
76                 "description": "Library ID",
77                 "required": false,
78                 "type": "string"
79             }],
80             "produces": [
81                 "application/json"
82             ],
83             "responses": {
84                 "200": {
85                     "description": "A list of ILL requests"
86                 },
87                 "401": {
88                   "description": "Authentication required",
89                   "schema": {
90                     "$ref": "../definitions.json#/error"
91                   }
92                 },
93                 "403": {
94                   "description": "Access forbidden",
95                   "schema": {
96                     "$ref": "../definitions.json#/error"
97                   }
98                 },
99                 "404": {
100                   "description": "ILL requests not found",
101                   "schema": {
102                     "$ref": "../definitions.json#/error"
103                   }
104                 },
105                 "500": {
106                   "description": "Internal server error",
107                   "schema": {
108                     "$ref": "../definitions.json#/error"
109                   }
110                 },
111                 "503": {
112                   "description": "Under maintenance",
113                   "schema": {
114                     "$ref": "../definitions.json#/error"
115                   }
116                 }
117             },
118             "x-koha-authorization": {
119                 "permissions": {
120                     "ill": "1"
121                 }
122             }
123         }
124     }
125 }