|
Line 0
Link Here
|
|
|
1 |
--- |
| 2 |
/authorised_value_categories: |
| 3 |
get: |
| 4 |
x-mojo-to: AuthorisedValueCategories#list |
| 5 |
operationId: listAuthorisedValueCategories |
| 6 |
tags: |
| 7 |
- authorised_value_categories |
| 8 |
summary: List authorised value categories |
| 9 |
produces: |
| 10 |
- application/json |
| 11 |
parameters: |
| 12 |
- name: category_names |
| 13 |
in: query |
| 14 |
description: Case insensitive search on category names |
| 15 |
required: false |
| 16 |
type: array |
| 17 |
- name: x-koha-embed |
| 18 |
in: header |
| 19 |
required: false |
| 20 |
description: Embed list sent as a request header |
| 21 |
type: array |
| 22 |
items: |
| 23 |
type: string |
| 24 |
enum: |
| 25 |
- authorised_values |
| 26 |
collectionFormat: csv |
| 27 |
- $ref: "../swagger.yaml#/parameters/match" |
| 28 |
- $ref: "../swagger.yaml#/parameters/order_by" |
| 29 |
- $ref: "../swagger.yaml#/parameters/page" |
| 30 |
- $ref: "../swagger.yaml#/parameters/per_page" |
| 31 |
- $ref: "../swagger.yaml#/parameters/q_param" |
| 32 |
- $ref: "../swagger.yaml#/parameters/q_body" |
| 33 |
- $ref: "../swagger.yaml#/parameters/q_header" |
| 34 |
responses: |
| 35 |
200: |
| 36 |
description: A list of authorised value categories |
| 37 |
schema: |
| 38 |
items: |
| 39 |
$ref: "../swagger.yaml#/definitions/authorised_value_category" |
| 40 |
type: array |
| 41 |
400: |
| 42 |
description: Bad request |
| 43 |
schema: |
| 44 |
$ref: "../swagger.yaml#/definitions/error" |
| 45 |
403: |
| 46 |
description: Access forbidden |
| 47 |
schema: |
| 48 |
$ref: "../swagger.yaml#/definitions/error" |
| 49 |
404: |
| 50 |
description: Resource not found |
| 51 |
schema: |
| 52 |
$ref: "../swagger.yaml#/definitions/error" |
| 53 |
500: |
| 54 |
description: |- |
| 55 |
Internal server error. Possible `error_code` attribute values: |
| 56 |
* `internal_server_error` |
| 57 |
schema: |
| 58 |
$ref: "../swagger.yaml#/definitions/error" |
| 59 |
503: |
| 60 |
description: Under maintenance |
| 61 |
schema: |
| 62 |
$ref: "../swagger.yaml#/definitions/error" |
| 63 |
x-koha-authorization: |
| 64 |
permissions: |
| 65 |
catalogue: 1 |