Line 0
Link Here
|
|
|
1 |
--- |
2 |
/library_groups: |
3 |
get: |
4 |
x-mojo-to: LibraryGroups#list |
5 |
operationId: listLibraryGroups |
6 |
tags: |
7 |
- library_groups |
8 |
summary: List library groups |
9 |
parameters: |
10 |
- name: parent_id |
11 |
in: query |
12 |
description: Identifier for the parent group |
13 |
required: false |
14 |
type: integer |
15 |
- name: branchcode |
16 |
in: query |
17 |
description: Branchcode included in the group |
18 |
required: false |
19 |
type: string |
20 |
- name: title |
21 |
in: query |
22 |
description: title of the library group |
23 |
required: false |
24 |
type: string |
25 |
- name: description |
26 |
in: query |
27 |
description: description of the library group |
28 |
required: false |
29 |
type: string |
30 |
- name: ft_hide_patron_info |
31 |
in: query |
32 |
description: search on ft_hide_patron_info |
33 |
required: false |
34 |
type: integer |
35 |
- name: ft_limit_item_editing |
36 |
in: query |
37 |
description: search on ft_limit_item_editing |
38 |
required: false |
39 |
type: integer |
40 |
- name: ft_search_groups_opac |
41 |
in: query |
42 |
description: search on ft_search_groups_opac |
43 |
required: false |
44 |
type: integer |
45 |
- name: ft_search_groups_staff |
46 |
in: query |
47 |
description: search on ft_search_groups_staff |
48 |
required: false |
49 |
type: integer |
50 |
- name: ft_local_hold_group |
51 |
in: query |
52 |
description: search on ft_local_hold_group |
53 |
required: false |
54 |
type: integer |
55 |
- name: ft_local_float_group |
56 |
in: query |
57 |
description: search on ft_local_float_group |
58 |
required: false |
59 |
type: integer |
60 |
- name: ft_acquisitions |
61 |
in: query |
62 |
description: search on ft_acquisitions |
63 |
required: false |
64 |
type: integer |
65 |
- $ref: "../swagger.yaml#/parameters/match" |
66 |
- $ref: "../swagger.yaml#/parameters/order_by" |
67 |
- $ref: "../swagger.yaml#/parameters/page" |
68 |
- $ref: "../swagger.yaml#/parameters/per_page" |
69 |
- $ref: "../swagger.yaml#/parameters/q_param" |
70 |
- $ref: "../swagger.yaml#/parameters/q_body" |
71 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
72 |
produces: |
73 |
- application/json |
74 |
responses: |
75 |
"200": |
76 |
description: A list of library groups |
77 |
schema: |
78 |
type: array |
79 |
items: |
80 |
$ref: "../swagger.yaml#/definitions/library_group" |
81 |
"400": |
82 |
description: | |
83 |
Bad request. Possible `error_code` attribute values: |
84 |
|
85 |
* `invalid_query` |
86 |
schema: |
87 |
$ref: "../swagger.yaml#/definitions/error" |
88 |
"500": |
89 |
description: | |
90 |
Internal server error. Possible `error_code` attribute values: |
91 |
|
92 |
* `internal_server_error` |
93 |
schema: |
94 |
$ref: "../swagger.yaml#/definitions/error" |
95 |
"503": |
96 |
description: Under maintenance |
97 |
schema: |
98 |
$ref: "../swagger.yaml#/definitions/error" |
99 |
x-koha-authorization: |
100 |
permissions: |
101 |
catalogue: "1" |