api/v1/swagger/paths/authorised_values.yaml

   1 ---
   2 "/authorised_value_categories/{authorised_value_category_name}/values":
   3   get:
   4     x-mojo-to: AuthorisedValues#list_av_from_category
   5     operationId: listAuthorisedValues
   6     tags:
   7       - authorised_values
   8     summary: List authorised values for a given category
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: category name
  13         in: path
  14         name: authorised_value_category_name
  15         required: true
  16         type: string
  17       - description: Case insensitive search on authorised value id
  18         in: query
  19         name: authorised_value_id
  20         required: false
  21         type: integer
  22       - description: Case insensitive search on authorised value category name
  23         in: query
  24         name: category_name
  25         required: false
  26         type: string
  27       - description: Case insensitive search on value
  28         in: query
  29         name: value
  30         required: false
  31         type: string
  32       - description: Case insensitive search on description
  33         in: query
  34         name: description
  35         required: false
  36         type: string
  37       - description: Case insensitive search on opac description
  38         in: query
  39         name: opac_description
  40         required: false
  41         type: string
  42       - description: Case insensitive search on image url
  43         in: query
  44         name: image_url
  45         required: false
  46         type: string
  47       - $ref: "../swagger.yaml#/parameters/match"
  48       - $ref: "../swagger.yaml#/parameters/order_by"
  49       - $ref: "../swagger.yaml#/parameters/page"
  50       - $ref: "../swagger.yaml#/parameters/per_page"
  51       - $ref: "../swagger.yaml#/parameters/q_param"
  52       - $ref: "../swagger.yaml#/parameters/q_body"
  53       - $ref: "../swagger.yaml#/parameters/q_header"
  54     responses:
  55       200:
  56         description: A list of authorised values
  57         schema:
  58           items:
  59             $ref: "../swagger.yaml#/definitions/authorised_value"
  60           type: array
  61       400:
  62         description: Bad request
  63         schema:
  64           $ref: "../swagger.yaml#/definitions/error"
  65       403:
  66         description: Access forbidden
  67         schema:
  68           $ref: "../swagger.yaml#/definitions/error"
  69       404:
  70         description: Ressource not found
  71         schema:
  72           $ref: "../swagger.yaml#/definitions/error"
  73       500:
  74         description: |-
  75           Internal server error. Possible `error_code` attribute values:
  76           * `internal_server_error`
  77         schema:
  78           $ref: "../swagger.yaml#/definitions/error"
  79       503:
  80         description: Under maintenance
  81         schema:
  82           $ref: "../swagger.yaml#/definitions/error"
  83     x-koha-authorization:
  84       permissions:
  85         catalogue: 1