Line 0
Link Here
|
|
|
1 |
--- |
2 |
/illbatchstatuses: |
3 |
get: |
4 |
x-mojo-to: IllbatchStatuses#list |
5 |
operationId: listIllbatchstatuses |
6 |
tags: |
7 |
- illbatchstatuses |
8 |
summary: List ILL batch statuses |
9 |
parameters: [] |
10 |
produces: |
11 |
- application/json |
12 |
responses: |
13 |
"200": |
14 |
description: A list of ILL batch statuses |
15 |
schema: |
16 |
$ref: "../swagger.yaml#/definitions/illbatchstatuses" |
17 |
"401": |
18 |
description: Authentication required |
19 |
schema: |
20 |
$ref: "../swagger.yaml#/definitions/error" |
21 |
"403": |
22 |
description: Access forbidden |
23 |
schema: |
24 |
$ref: "../swagger.yaml#/definitions/error" |
25 |
"404": |
26 |
description: ILL batch statuses not found |
27 |
schema: |
28 |
$ref: "../swagger.yaml#/definitions/error" |
29 |
"500": |
30 |
description: | |
31 |
Internal server error. Possible `error_code` attribute values: |
32 |
|
33 |
* `internal_server_error` |
34 |
schema: |
35 |
$ref: "../swagger.yaml#/definitions/error" |
36 |
"503": |
37 |
description: Under maintenance |
38 |
schema: |
39 |
$ref: "../swagger.yaml#/definitions/error" |
40 |
x-koha-authorization: |
41 |
permissions: |
42 |
ill: "1" |
43 |
post: |
44 |
x-mojo-to: IllbatchStatuses#add |
45 |
operationId: addIllbatchstatus |
46 |
tags: |
47 |
- illbatchstatuses |
48 |
summary: Add ILL batch status |
49 |
parameters: |
50 |
- name: body |
51 |
in: body |
52 |
description: A JSON object containing informations about the new batch status |
53 |
required: true |
54 |
schema: |
55 |
$ref: "../swagger.yaml#/definitions/illbatchstatus" |
56 |
produces: |
57 |
- application/json |
58 |
responses: |
59 |
"201": |
60 |
description: Batch status added |
61 |
schema: |
62 |
$ref: "../swagger.yaml#/definitions/illbatchstatus" |
63 |
"400": |
64 |
description: Bad request |
65 |
schema: |
66 |
$ref: "../swagger.yaml#/definitions/error" |
67 |
"401": |
68 |
description: Authentication required |
69 |
schema: |
70 |
$ref: "../swagger.yaml#/definitions/error" |
71 |
"403": |
72 |
description: Access forbidden |
73 |
schema: |
74 |
$ref: "../swagger.yaml#/definitions/error" |
75 |
"409": |
76 |
description: Conflict in creating resource |
77 |
schema: |
78 |
$ref: "../swagger.yaml#/definitions/error" |
79 |
"500": |
80 |
description: | |
81 |
Internal server error. Possible `error_code` attribute values: |
82 |
|
83 |
* `internal_server_error` |
84 |
schema: |
85 |
$ref: "../swagger.yaml#/definitions/error" |
86 |
"503": |
87 |
description: Under maintenance |
88 |
schema: |
89 |
$ref: "../swagger.yaml#/definitions/error" |
90 |
x-koha-authorization: |
91 |
permissions: |
92 |
ill: "1" |
93 |
"/illbatchstatuses/{illbatchstatus_code}": |
94 |
get: |
95 |
x-mojo-to: IllbatchStatuses#get |
96 |
operationId: getIllbatchstatuses |
97 |
tags: |
98 |
- illbatchstatuses |
99 |
summary: Get ILL batch status |
100 |
parameters: |
101 |
- name: illbatchstatus_code |
102 |
in: path |
103 |
description: ILL batch status |
104 |
required: true |
105 |
type: string |
106 |
produces: |
107 |
- application/json |
108 |
responses: |
109 |
"200": |
110 |
description: An ILL batch status |
111 |
schema: |
112 |
$ref: "../swagger.yaml#/definitions/illbatchstatus" |
113 |
"401": |
114 |
description: Authentication required |
115 |
schema: |
116 |
$ref: "../swagger.yaml#/definitions/error" |
117 |
"403": |
118 |
description: Access forbidden |
119 |
schema: |
120 |
$ref: "../swagger.yaml#/definitions/error" |
121 |
"404": |
122 |
description: ILL batch status not found |
123 |
schema: |
124 |
$ref: "../swagger.yaml#/definitions/error" |
125 |
"500": |
126 |
description: | |
127 |
Internal server error. Possible `error_code` attribute values: |
128 |
|
129 |
* `internal_server_error` |
130 |
schema: |
131 |
$ref: "../swagger.yaml#/definitions/error" |
132 |
"503": |
133 |
description: Under maintenance |
134 |
schema: |
135 |
$ref: "../swagger.yaml#/definitions/error" |
136 |
x-koha-authorization: |
137 |
permissions: |
138 |
ill: "1" |
139 |
put: |
140 |
x-mojo-to: IllbatchStatuses#update |
141 |
operationId: updateIllBatchstatus |
142 |
tags: |
143 |
- illbatchstatuses |
144 |
summary: Update batch status |
145 |
parameters: |
146 |
- $ref: "../swagger.yaml#/parameters/illbatchstatus_code_pp" |
147 |
- name: body |
148 |
in: body |
149 |
description: A JSON object containing information on the batch status |
150 |
required: true |
151 |
schema: |
152 |
$ref: "../swagger.yaml#/definitions/illbatchstatus" |
153 |
consumes: |
154 |
- application/json |
155 |
produces: |
156 |
- application/json |
157 |
responses: |
158 |
"200": |
159 |
description: An ILL batch status |
160 |
schema: |
161 |
$ref: "../swagger.yaml#/definitions/illbatchstatus" |
162 |
"400": |
163 |
description: Bad request |
164 |
schema: |
165 |
$ref: "../swagger.yaml#/definitions/error" |
166 |
"401": |
167 |
description: Authentication required |
168 |
schema: |
169 |
$ref: "../swagger.yaml#/definitions/error" |
170 |
"403": |
171 |
description: Access forbidden |
172 |
schema: |
173 |
$ref: "../swagger.yaml#/definitions/error" |
174 |
"404": |
175 |
description: ILL batch status not found |
176 |
schema: |
177 |
$ref: "../swagger.yaml#/definitions/error" |
178 |
"500": |
179 |
description: | |
180 |
Internal server error. Possible `error_code` attribute values: |
181 |
|
182 |
* `internal_server_error` |
183 |
schema: |
184 |
$ref: "../swagger.yaml#/definitions/error" |
185 |
"503": |
186 |
description: Under maintenance |
187 |
schema: |
188 |
$ref: "../swagger.yaml#/definitions/error" |
189 |
x-koha-authorization: |
190 |
permissions: |
191 |
ill: "1" |
192 |
delete: |
193 |
x-mojo-to: IllbatchStatuses#delete |
194 |
operationId: deleteBatchstatus |
195 |
tags: |
196 |
- illbatchstatuses |
197 |
summary: Delete ILL batch status |
198 |
parameters: |
199 |
- $ref: "../swagger.yaml#/parameters/illbatchstatus_code_pp" |
200 |
produces: |
201 |
- application/json |
202 |
responses: |
203 |
"204": |
204 |
description: ILL batch status deleted |
205 |
schema: |
206 |
type: string |
207 |
"401": |
208 |
description: Authentication required |
209 |
schema: |
210 |
$ref: "../swagger.yaml#/definitions/error" |
211 |
"403": |
212 |
description: Access forbidden |
213 |
schema: |
214 |
$ref: "../swagger.yaml#/definitions/error" |
215 |
"404": |
216 |
description: ILL batch status not found |
217 |
schema: |
218 |
$ref: "../swagger.yaml#/definitions/error" |
219 |
"500": |
220 |
description: | |
221 |
Internal server error. Possible `error_code` attribute values: |
222 |
|
223 |
* `internal_server_error` |
224 |
schema: |
225 |
$ref: "../swagger.yaml#/definitions/error" |
226 |
"503": |
227 |
description: Under maintenance |
228 |
schema: |
229 |
$ref: "../swagger.yaml#/definitions/error" |
230 |
x-koha-authorization: |
231 |
permissions: |
232 |
ill: "1" |