|
Line 0
Link Here
|
|
|
1 |
--- |
| 2 |
/display/items: |
| 3 |
get: |
| 4 |
x-mojo-to: DisplayItems#list |
| 5 |
operationId: listDisplayItems |
| 6 |
tags: |
| 7 |
- displayitems |
| 8 |
summary: List display items |
| 9 |
produces: |
| 10 |
- application/json |
| 11 |
parameters: |
| 12 |
- name: display_item_id |
| 13 |
in: query |
| 14 |
description: Filter by display item ID |
| 15 |
required: false |
| 16 |
type: integer |
| 17 |
- name: display_id |
| 18 |
in: query |
| 19 |
description: Filter by display ID |
| 20 |
required: false |
| 21 |
type: integer |
| 22 |
- name: itemnumber |
| 23 |
in: query |
| 24 |
description: Filter by item number |
| 25 |
required: false |
| 26 |
type: integer |
| 27 |
- name: biblionumber |
| 28 |
in: query |
| 29 |
description: Filter by bibliographic record number |
| 30 |
required: false |
| 31 |
type: integer |
| 32 |
- name: date_added |
| 33 |
in: query |
| 34 |
description: Filter by date added |
| 35 |
required: false |
| 36 |
type: string |
| 37 |
format: date |
| 38 |
- name: date_remove |
| 39 |
in: query |
| 40 |
description: Filter by date to remove |
| 41 |
required: false |
| 42 |
type: string |
| 43 |
format: date |
| 44 |
- $ref: "../swagger.yaml#/parameters/match" |
| 45 |
- $ref: "../swagger.yaml#/parameters/order_by" |
| 46 |
- $ref: "../swagger.yaml#/parameters/page" |
| 47 |
- $ref: "../swagger.yaml#/parameters/per_page" |
| 48 |
- $ref: "../swagger.yaml#/parameters/q_param" |
| 49 |
- $ref: "../swagger.yaml#/parameters/q_body" |
| 50 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
| 51 |
responses: |
| 52 |
"200": |
| 53 |
description: A list of display items |
| 54 |
schema: |
| 55 |
type: array |
| 56 |
items: |
| 57 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 58 |
"400": |
| 59 |
description: | |
| 60 |
Bad request. Possible `error_code` attribute values: |
| 61 |
|
| 62 |
* `invalid_query` |
| 63 |
schema: |
| 64 |
$ref: "../swagger.yaml#/definitions/error" |
| 65 |
"403": |
| 66 |
description: Access forbidden |
| 67 |
schema: |
| 68 |
$ref: "../swagger.yaml#/definitions/error" |
| 69 |
"500": |
| 70 |
description: | |
| 71 |
Internal server error. Possible `error_code` attribute values: |
| 72 |
|
| 73 |
* `internal_server_error` |
| 74 |
schema: |
| 75 |
$ref: "../swagger.yaml#/definitions/error" |
| 76 |
"503": |
| 77 |
description: Under maintenance |
| 78 |
schema: |
| 79 |
$ref: "../swagger.yaml#/definitions/error" |
| 80 |
x-koha-authorization: |
| 81 |
permissions: |
| 82 |
displays: "*" |
| 83 |
post: |
| 84 |
x-mojo-to: DisplayItems#add |
| 85 |
operationId: addDisplayItem |
| 86 |
tags: |
| 87 |
- displayitems |
| 88 |
summary: Add display item |
| 89 |
parameters: |
| 90 |
- name: body |
| 91 |
in: body |
| 92 |
description: A JSON object containing information about the new display item |
| 93 |
required: true |
| 94 |
schema: |
| 95 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 96 |
produces: |
| 97 |
- application/json |
| 98 |
responses: |
| 99 |
"201": |
| 100 |
description: Display item added |
| 101 |
schema: |
| 102 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 103 |
"400": |
| 104 |
description: Bad request |
| 105 |
schema: |
| 106 |
$ref: "../swagger.yaml#/definitions/error" |
| 107 |
"401": |
| 108 |
description: Authentication required |
| 109 |
schema: |
| 110 |
$ref: "../swagger.yaml#/definitions/error" |
| 111 |
"403": |
| 112 |
description: Access forbidden |
| 113 |
schema: |
| 114 |
$ref: "../swagger.yaml#/definitions/error" |
| 115 |
"500": |
| 116 |
description: | |
| 117 |
Internal server error. Possible `error_code` attribute values: |
| 118 |
|
| 119 |
* `internal_server_error` |
| 120 |
schema: |
| 121 |
$ref: "../swagger.yaml#/definitions/error" |
| 122 |
"503": |
| 123 |
description: Under maintenance |
| 124 |
schema: |
| 125 |
$ref: "../swagger.yaml#/definitions/error" |
| 126 |
x-koha-authorization: |
| 127 |
permissions: |
| 128 |
displays: add_items_to_display |
| 129 |
"/display/items/{display_id}/{item_id}": |
| 130 |
get: |
| 131 |
x-mojo-to: DisplayItems#get |
| 132 |
operationId: getDisplayItem |
| 133 |
tags: |
| 134 |
- displayitems |
| 135 |
summary: Get display item |
| 136 |
parameters: |
| 137 |
- $ref: "../swagger.yaml#/parameters/display_id_pp" |
| 138 |
- $ref: "../swagger.yaml#/parameters/item_id_pp" |
| 139 |
produces: |
| 140 |
- application/json |
| 141 |
responses: |
| 142 |
"200": |
| 143 |
description: A display item |
| 144 |
schema: |
| 145 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 146 |
"400": |
| 147 |
description: Bad request |
| 148 |
schema: |
| 149 |
$ref: "../swagger.yaml#/definitions/error" |
| 150 |
"404": |
| 151 |
description: Display item not found |
| 152 |
schema: |
| 153 |
$ref: "../swagger.yaml#/definitions/error" |
| 154 |
"500": |
| 155 |
description: | |
| 156 |
Internal server error. Possible `error_code` attribute values: |
| 157 |
|
| 158 |
* `internal_server_error` |
| 159 |
schema: |
| 160 |
$ref: "../swagger.yaml#/definitions/error" |
| 161 |
"503": |
| 162 |
description: Under maintenance |
| 163 |
schema: |
| 164 |
$ref: "../swagger.yaml#/definitions/error" |
| 165 |
x-koha-authorization: |
| 166 |
permissions: |
| 167 |
displays: "*" |
| 168 |
put: |
| 169 |
x-mojo-to: DisplayItems#update |
| 170 |
operationId: updateDisplayItem |
| 171 |
tags: |
| 172 |
- displayitems |
| 173 |
summary: Update display item |
| 174 |
parameters: |
| 175 |
- $ref: "../swagger.yaml#/parameters/display_id_pp" |
| 176 |
- $ref: "../swagger.yaml#/parameters/item_id_pp" |
| 177 |
- name: body |
| 178 |
in: body |
| 179 |
description: A display item object |
| 180 |
required: true |
| 181 |
schema: |
| 182 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 183 |
produces: |
| 184 |
- application/json |
| 185 |
responses: |
| 186 |
"200": |
| 187 |
description: A display item |
| 188 |
schema: |
| 189 |
$ref: "../swagger.yaml#/definitions/displayitem" |
| 190 |
"400": |
| 191 |
description: Bad request |
| 192 |
schema: |
| 193 |
$ref: "../swagger.yaml#/definitions/error" |
| 194 |
"401": |
| 195 |
description: Authentication required |
| 196 |
schema: |
| 197 |
$ref: "../swagger.yaml#/definitions/error" |
| 198 |
"403": |
| 199 |
description: Access forbidden |
| 200 |
schema: |
| 201 |
$ref: "../swagger.yaml#/definitions/error" |
| 202 |
"404": |
| 203 |
description: Display item not found |
| 204 |
schema: |
| 205 |
$ref: "../swagger.yaml#/definitions/error" |
| 206 |
"500": |
| 207 |
description: Internal error |
| 208 |
schema: |
| 209 |
$ref: "../swagger.yaml#/definitions/error" |
| 210 |
"503": |
| 211 |
description: Under maintenance |
| 212 |
schema: |
| 213 |
$ref: "../swagger.yaml#/definitions/error" |
| 214 |
x-koha-authorization: |
| 215 |
permissions: |
| 216 |
displays: add_items_to_display |
| 217 |
delete: |
| 218 |
x-mojo-to: DisplayItems#delete |
| 219 |
operationId: deleteDisplayItem |
| 220 |
tags: |
| 221 |
- displayitems |
| 222 |
summary: Delete display item |
| 223 |
parameters: |
| 224 |
- $ref: "../swagger.yaml#/parameters/display_id_pp" |
| 225 |
- $ref: "../swagger.yaml#/parameters/item_id_pp" |
| 226 |
produces: |
| 227 |
- application/json |
| 228 |
responses: |
| 229 |
"204": |
| 230 |
description: Display item deleted |
| 231 |
"400": |
| 232 |
description: Bad request |
| 233 |
schema: |
| 234 |
$ref: "../swagger.yaml#/definitions/error" |
| 235 |
"401": |
| 236 |
description: Authentication required |
| 237 |
schema: |
| 238 |
$ref: "../swagger.yaml#/definitions/error" |
| 239 |
"403": |
| 240 |
description: Access forbidden |
| 241 |
schema: |
| 242 |
$ref: "../swagger.yaml#/definitions/error" |
| 243 |
"404": |
| 244 |
description: Display item not found |
| 245 |
schema: |
| 246 |
$ref: "../swagger.yaml#/definitions/error" |
| 247 |
"500": |
| 248 |
description: Internal error |
| 249 |
schema: |
| 250 |
$ref: "../swagger.yaml#/definitions/error" |
| 251 |
"503": |
| 252 |
description: Under maintenance |
| 253 |
schema: |
| 254 |
$ref: "../swagger.yaml#/definitions/error" |
| 255 |
x-koha-authorization: |
| 256 |
permissions: |
| 257 |
displays: remove_items_from_display |
| 258 |
/display/items/batch: |
| 259 |
post: |
| 260 |
x-mojo-to: DisplayItems#batch_add |
| 261 |
operationId: batchAddDisplayItems |
| 262 |
tags: |
| 263 |
- displayitems |
| 264 |
summary: Add multiple items to a display |
| 265 |
parameters: |
| 266 |
- name: body |
| 267 |
in: body |
| 268 |
description: A JSON object containing display and item information |
| 269 |
required: true |
| 270 |
schema: |
| 271 |
type: object |
| 272 |
properties: |
| 273 |
display_id: |
| 274 |
description: ID of the display to add items to |
| 275 |
type: integer |
| 276 |
item_ids: |
| 277 |
description: Array of item numbers to add to the display |
| 278 |
type: array |
| 279 |
items: |
| 280 |
type: integer |
| 281 |
minItems: 1 |
| 282 |
date_remove: |
| 283 |
description: Optional date when items should be removed from display |
| 284 |
type: string |
| 285 |
format: date |
| 286 |
required: |
| 287 |
- display_id |
| 288 |
- item_ids |
| 289 |
additionalProperties: false |
| 290 |
produces: |
| 291 |
- application/json |
| 292 |
responses: |
| 293 |
"202": |
| 294 |
description: Batch operation queued |
| 295 |
schema: |
| 296 |
type: object |
| 297 |
properties: |
| 298 |
job_id: |
| 299 |
type: integer |
| 300 |
description: ID of the background job processing this request |
| 301 |
message: |
| 302 |
type: string |
| 303 |
description: Confirmation message |
| 304 |
additionalProperties: false |
| 305 |
"400": |
| 306 |
description: Bad request |
| 307 |
schema: |
| 308 |
$ref: "../swagger.yaml#/definitions/error" |
| 309 |
"401": |
| 310 |
description: Authentication required |
| 311 |
schema: |
| 312 |
$ref: "../swagger.yaml#/definitions/error" |
| 313 |
"403": |
| 314 |
description: Access forbidden |
| 315 |
schema: |
| 316 |
$ref: "../swagger.yaml#/definitions/error" |
| 317 |
"404": |
| 318 |
description: Display not found |
| 319 |
schema: |
| 320 |
$ref: "../swagger.yaml#/definitions/error" |
| 321 |
"500": |
| 322 |
description: Internal server error |
| 323 |
schema: |
| 324 |
$ref: "../swagger.yaml#/definitions/error" |
| 325 |
"503": |
| 326 |
description: Under maintenance |
| 327 |
schema: |
| 328 |
$ref: "../swagger.yaml#/definitions/error" |
| 329 |
x-koha-authorization: |
| 330 |
permissions: |
| 331 |
displays: add_items_to_display |
| 332 |
delete: |
| 333 |
x-mojo-to: DisplayItems#batch_delete |
| 334 |
operationId: batchDeleteDisplayItems |
| 335 |
tags: |
| 336 |
- displayitems |
| 337 |
summary: Remove multiple items from displays |
| 338 |
parameters: |
| 339 |
- name: body |
| 340 |
in: body |
| 341 |
description: A JSON object containing item information |
| 342 |
required: true |
| 343 |
schema: |
| 344 |
type: object |
| 345 |
properties: |
| 346 |
item_ids: |
| 347 |
description: Array of item numbers to remove from displays |
| 348 |
type: array |
| 349 |
items: |
| 350 |
type: integer |
| 351 |
minItems: 1 |
| 352 |
display_id: |
| 353 |
description: Optional display ID - if specified, only remove items from this display |
| 354 |
type: integer |
| 355 |
required: |
| 356 |
- item_ids |
| 357 |
additionalProperties: false |
| 358 |
produces: |
| 359 |
- application/json |
| 360 |
responses: |
| 361 |
"202": |
| 362 |
description: Batch operation queued |
| 363 |
schema: |
| 364 |
type: object |
| 365 |
properties: |
| 366 |
job_id: |
| 367 |
type: integer |
| 368 |
description: ID of the background job processing this request |
| 369 |
message: |
| 370 |
type: string |
| 371 |
description: Confirmation message |
| 372 |
additionalProperties: false |
| 373 |
"400": |
| 374 |
description: Bad request |
| 375 |
schema: |
| 376 |
$ref: "../swagger.yaml#/definitions/error" |
| 377 |
"401": |
| 378 |
description: Authentication required |
| 379 |
schema: |
| 380 |
$ref: "../swagger.yaml#/definitions/error" |
| 381 |
"403": |
| 382 |
description: Access forbidden |
| 383 |
schema: |
| 384 |
$ref: "../swagger.yaml#/definitions/error" |
| 385 |
"500": |
| 386 |
description: Internal server error |
| 387 |
schema: |
| 388 |
$ref: "../swagger.yaml#/definitions/error" |
| 389 |
"503": |
| 390 |
description: Under maintenance |
| 391 |
schema: |
| 392 |
$ref: "../swagger.yaml#/definitions/error" |
| 393 |
x-koha-authorization: |
| 394 |
permissions: |
| 395 |
displays: remove_items_from_display |