api/v1/swagger/paths/acquisitions_funds.yaml

   1 ---
   2 /acquisitions/funds:
   3   get:
   4     x-mojo-to: Acquisitions::Funds#list
   5     operationId: listFunds
   6     tags:
   7       - funds
   8     summary: List funds
   9     produces:
  10       - application/json
  11     parameters:
  12       - name: name
  13         in: query
  14         description: Case insensitive search on fund name
  15         required: false
  16         type: string
  17       - name: fund_owner_id
  18         in: query
  19         description: Display only the funds that belongs to the given patron ID
  20         required: false
  21         type: integer
  22       - $ref: "../swagger.yaml#/parameters/match"
  23       - $ref: "../swagger.yaml#/parameters/order_by"
  24       - $ref: "../swagger.yaml#/parameters/page"
  25       - $ref: "../swagger.yaml#/parameters/per_page"
  26       - $ref: "../swagger.yaml#/parameters/q_param"
  27       - $ref: "../swagger.yaml#/parameters/q_body"
  28       - $ref: "../swagger.yaml#/parameters/q_header"
  29       - $ref: "../swagger.yaml#/parameters/request_id_header"
  30     responses:
  31       "200":
  32         description: A list of funds
  33         schema:
  34           type: array
  35           items:
  36             $ref: "../swagger.yaml#/definitions/fund"
  37       "401":
  38         description: Authentication required
  39         schema:
  40           $ref: "../swagger.yaml#/definitions/error"
  41       "403":
  42         description: Access forbidden
  43         schema:
  44           $ref: "../swagger.yaml#/definitions/error"
  45       "404":
  46         description: Fund not found
  47         schema:
  48           $ref: "../swagger.yaml#/definitions/error"
  49       "500":
  50         description: |
  51           Internal server error. Possible `error_code` attribute values:
  52
  53           * `internal_server_error`
  54         schema:
  55           $ref: "../swagger.yaml#/definitions/error"
  56       "503":
  57         description: Under maintenance
  58         schema:
  59           $ref: "../swagger.yaml#/definitions/error"
  60     x-koha-authorization:
  61       permissions:
  62         acquisition: budget_manage_all
  63 /acquisitions/funds/owners:
  64   get:
  65     x-mojo-to: Acquisitions::Funds#list_owners
  66     operationId: listFundsOwners
  67     description: This resource returns a list of patron allowed to be owner of funds
  68     summary: List possibe owners for funds
  69     tags:
  70       - funds
  71     parameters:
  72       - $ref: "../swagger.yaml#/parameters/match"
  73       - $ref: "../swagger.yaml#/parameters/order_by"
  74       - $ref: "../swagger.yaml#/parameters/page"
  75       - $ref: "../swagger.yaml#/parameters/per_page"
  76       - $ref: "../swagger.yaml#/parameters/q_param"
  77       - $ref: "../swagger.yaml#/parameters/q_body"
  78       - $ref: "../swagger.yaml#/parameters/q_header"
  79       - name: x-koha-embed
  80         in: header
  81         required: false
  82         description: Embed list sent as a request header
  83         type: array
  84         items:
  85           type: string
  86           enum:
  87             - extended_attributes
  88         collectionFormat: csv
  89     produces:
  90       - application/json
  91     responses:
  92       "200":
  93         description: A list of funds' owners
  94         schema:
  95           type: array
  96           items:
  97             $ref: "../swagger.yaml#/definitions/patron"
  98       "403":
  99         description: Access forbidden
 100         schema:
 101           $ref: "../swagger.yaml#/definitions/error"
 102       "500":
 103         description: |
 104           Internal server error. Possible `error_code` attribute values:
 105
 106           * `internal_server_error`
 107         schema:
 108           $ref: "../swagger.yaml#/definitions/error"
 109       "503":
 110         description: Under maintenance
 111         schema:
 112           $ref: "../swagger.yaml#/definitions/error"
 113     x-koha-authorization:
 114       permissions:
 115         acquisition: budget_modify
 116 /acquisitions/funds/users:
 117   get:
 118     x-mojo-to: Acquisitions::Funds#list_users
 119     operationId: listFundsUsers
 120     description: This resource returns a list of patron allowed to be owner of funds
 121     summary: List possibe users for funds
 122     tags:
 123       - funds
 124     parameters:
 125       - $ref: "../swagger.yaml#/parameters/match"
 126       - $ref: "../swagger.yaml#/parameters/order_by"
 127       - $ref: "../swagger.yaml#/parameters/page"
 128       - $ref: "../swagger.yaml#/parameters/per_page"
 129       - $ref: "../swagger.yaml#/parameters/q_param"
 130       - $ref: "../swagger.yaml#/parameters/q_body"
 131       - $ref: "../swagger.yaml#/parameters/q_header"
 132       - name: x-koha-embed
 133         in: header
 134         required: false
 135         description: Embed list sent as a request header
 136         type: array
 137         items:
 138           type: string
 139           enum:
 140             - extended_attributes
 141         collectionFormat: csv
 142     produces:
 143       - application/json
 144     responses:
 145       "200":
 146         description: A list of funds' users
 147         schema:
 148           type: array
 149           items:
 150             $ref: "../swagger.yaml#/definitions/patron"
 151       "403":
 152         description: Access forbidden
 153         schema:
 154           $ref: "../swagger.yaml#/definitions/error"
 155       "500":
 156         description: |
 157           Internal server error. Possible `error_code` attribute values:
 158
 159           * `internal_server_error`
 160         schema:
 161           $ref: "../swagger.yaml#/definitions/error"
 162       "503":
 163         description: Under maintenance
 164         schema:
 165           $ref: "../swagger.yaml#/definitions/error"
 166     x-koha-authorization:
 167       permissions:
 168         acquisition: budget_modify