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     responses:
  30       "200":
  31         description: A list of funds
  32         schema:
  33           type: array
  34           items:
  35             $ref: "../swagger.yaml#/definitions/fund"
  36       "401":
  37         description: Authentication required
  38         schema:
  39           $ref: "../swagger.yaml#/definitions/error"
  40       "403":
  41         description: Access forbidden
  42         schema:
  43           $ref: "../swagger.yaml#/definitions/error"
  44       "404":
  45         description: Fund not found
  46         schema:
  47           $ref: "../swagger.yaml#/definitions/error"
  48       "500":
  49         description: |
  50           Internal server error. Possible `error_code` attribute values:
  51
  52           * `internal_server_error`
  53         schema:
  54           $ref: "../swagger.yaml#/definitions/error"
  55       "503":
  56         description: Under maintenance
  57         schema:
  58           $ref: "../swagger.yaml#/definitions/error"
  59     x-koha-authorization:
  60       permissions:
  61         acquisition: budget_manage_all
  62 /acquisitions/funds/owners:
  63   get:
  64     x-mojo-to: Acquisitions::Funds#list_owners
  65     operationId: listFundsOwners
  66     description: This resource returns a list of patron allowed to be owner of funds
  67     summary: List possibe owners for funds
  68     tags:
  69       - funds
  70     parameters:
  71       - $ref: "../swagger.yaml#/parameters/match"
  72       - $ref: "../swagger.yaml#/parameters/order_by"
  73       - $ref: "../swagger.yaml#/parameters/page"
  74       - $ref: "../swagger.yaml#/parameters/per_page"
  75       - $ref: "../swagger.yaml#/parameters/q_param"
  76       - $ref: "../swagger.yaml#/parameters/q_body"
  77       - $ref: "../swagger.yaml#/parameters/q_header"
  78     produces:
  79       - application/json
  80     responses:
  81       "200":
  82         description: A list of funds' owners
  83         schema:
  84           type: array
  85           items:
  86             $ref: "../swagger.yaml#/definitions/patron"
  87       "403":
  88         description: Access forbidden
  89         schema:
  90           $ref: "../swagger.yaml#/definitions/error"
  91       "500":
  92         description: |
  93           Internal server error. Possible `error_code` attribute values:
  94
  95           * `internal_server_error`
  96         schema:
  97           $ref: "../swagger.yaml#/definitions/error"
  98       "503":
  99         description: Under maintenance
 100         schema:
 101           $ref: "../swagger.yaml#/definitions/error"
 102     x-koha-authorization:
 103       permissions:
 104         acquisition: budget_modify
 105     x-koha-embed:
 106       - extended_attributes
 107 /acquisitions/funds/users:
 108   get:
 109     x-mojo-to: Acquisitions::Funds#list_users
 110     operationId: listFundsUsers
 111     description: This resource returns a list of patron allowed to be owner of funds
 112     summary: List possibe users for funds
 113     tags:
 114       - funds
 115     parameters:
 116       - $ref: "../swagger.yaml#/parameters/match"
 117       - $ref: "../swagger.yaml#/parameters/order_by"
 118       - $ref: "../swagger.yaml#/parameters/page"
 119       - $ref: "../swagger.yaml#/parameters/per_page"
 120       - $ref: "../swagger.yaml#/parameters/q_param"
 121       - $ref: "../swagger.yaml#/parameters/q_body"
 122       - $ref: "../swagger.yaml#/parameters/q_header"
 123     produces:
 124       - application/json
 125     responses:
 126       "200":
 127         description: A list of funds' users
 128         schema:
 129           type: array
 130           items:
 131             $ref: "../swagger.yaml#/definitions/patron"
 132       "403":
 133         description: Access forbidden
 134         schema:
 135           $ref: "../swagger.yaml#/definitions/error"
 136       "500":
 137         description: |
 138           Internal server error. Possible `error_code` attribute values:
 139
 140           * `internal_server_error`
 141         schema:
 142           $ref: "../swagger.yaml#/definitions/error"
 143       "503":
 144         description: Under maintenance
 145         schema:
 146           $ref: "../swagger.yaml#/definitions/error"
 147     x-koha-authorization:
 148       permissions:
 149         acquisition: budget_modify
 150     x-koha-embed:
 151       - extended_attributes