api/v1/swagger/paths/erm_default_usage_reports.yaml

   1 ---
   2 /erm/default_usage_reports:
   3   get:
   4     x-mojo-to: ERM::DefaultUsageReports#list
   5     operationId: listErmDefaultUsageReports
   6     tags:
   7       - default_usage_report
   8     summary: List default_usage_reports
   9     produces:
  10       - application/json
  11     parameters:
  12       - description: Case insensitive search on erm_default_usage_report_id
  13         in: query
  14         name: erm_default_usage_report_id
  15         required: false
  16         type: integer
  17       - description: Case insensitive search on default_usage_report report_name
  18         in: query
  19         name: report_name
  20         required: false
  21         type: integer
  22       - description: Case insensitive search on default_usage_report report_url_params
  23         in: query
  24         name: report_url_params
  25         required: false
  26         type: integer
  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     responses:
  34       200:
  35         description: A list of default_usage_reports
  36         schema:
  37           items:
  38             $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
  39           type: array
  40       400:
  41         description: Bad request
  42         schema:
  43           $ref: "../swagger.yaml#/definitions/error"
  44       403:
  45         description: Access forbidden
  46         schema:
  47           $ref: "../swagger.yaml#/definitions/error"
  48       500:
  49         description: |-
  50           Internal server error. Possible `error_code` attribute values:
  51           * `internal_server_error`
  52         schema:
  53           $ref: "../swagger.yaml#/definitions/error"
  54       503:
  55         description: Under maintenance
  56         schema:
  57           $ref: "../swagger.yaml#/definitions/error"
  58     x-koha-authorization:
  59       permissions:
  60         erm: 1
  61   post:
  62     x-mojo-to: ERM::DefaultUsageReports#add
  63     operationId: addErmDefaultUsageReports
  64     tags:
  65       - default_usage_report
  66     summary: Add default_usage_report
  67     consumes:
  68       - application/json
  69     produces:
  70       - application/json
  71     parameters:
  72       - description: A JSON object containing information about the new default_usage_report
  73         in: body
  74         name: body
  75         required: true
  76         schema:
  77             $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
  78     responses:
  79       201:
  80         description: A successfully created default_usage_report
  81         schema:
  82           items:
  83             $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
  84       400:
  85         description: Bad parameter
  86         schema:
  87           $ref: "../swagger.yaml#/definitions/error"
  88       401:
  89         description: Authentication required
  90         schema:
  91           $ref: "../swagger.yaml#/definitions/error"
  92       403:
  93         description: Access forbidden
  94         schema:
  95           $ref: "../swagger.yaml#/definitions/error"
  96       404:
  97         description: Ressource not found
  98         schema:
  99           $ref: "../swagger.yaml#/definitions/error"
 100       409:
 101         description: Conflict in creating resource
 102         schema:
 103           $ref: "../swagger.yaml#/definitions/error"
 104       413:
 105         description: Payload too large
 106         schema:
 107           $ref: "../swagger.yaml#/definitions/error"
 108       500:
 109         description: |-
 110           Internal server error. Possible `error_code` attribute values:
 111           * `internal_server_error`
 112         schema:
 113           $ref: "../swagger.yaml#/definitions/error"
 114       503:
 115         description: Under maintenance
 116         schema:
 117           $ref: "../swagger.yaml#/definitions/error"
 118     x-koha-authorization:
 119       permissions:
 120         erm: 1
 121 "/erm/default_usage_reports/{erm_default_usage_report_id}":
 122   get:
 123     x-mojo-to: ERM::DefaultUsageReports#get
 124     operationId: getERMDefaultUsageReport
 125     tags:
 126       - default_usage_report
 127     summary: get default_usage_report
 128     produces:
 129       - application/json
 130     parameters:
 131       - $ref: "../swagger.yaml#/parameters/erm_default_usage_report_id_pp"
 132     responses:
 133       200:
 134         description: default_usage_report
 135         schema:
 136           items:
 137             $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
 138       401:
 139         description: authentication required
 140         schema:
 141           $ref: "../swagger.yaml#/definitions/error"
 142       403:
 143         description: access forbidden
 144         schema:
 145           $ref: "../swagger.yaml#/definitions/error"
 146       404:
 147         description: ressource not found
 148         schema:
 149           $ref: "../swagger.yaml#/definitions/error"
 150       500:
 151         description: |-
 152           internal server error. possible `error_code` attribute values:
 153           * `internal_server_error`
 154         schema:
 155           $ref: "../swagger.yaml#/definitions/error"
 156       503:
 157         description: under maintenance
 158         schema:
 159           $ref: "../swagger.yaml#/definitions/error"
 160     x-koha-authorization:
 161       permissions:
 162         erm: 1
 163   put:
 164     x-mojo-to: ERM::DefaultUsageReports#update
 165     operationId: updateERMDefaultUsageReports
 166     tags:
 167       - default_usage_report
 168     summary: update default_usage_report
 169     consumes:
 170       - application/json
 171     produces:
 172       - application/json
 173     parameters:
 174       - $ref: "../swagger.yaml#/parameters/erm_default_usage_report_id_pp"
 175       - name: body
 176         in: body
 177         description: a json object containing new information about existing default_usage_report
 178         required: true
 179         schema:
 180           $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
 181     responses:
 182       200:
 183         description: a successfully updated default_usage_report
 184         schema:
 185           items:
 186             $ref: "../swagger.yaml#/definitions/erm_default_usage_report"
 187       400:
 188         description: bad parameter
 189         schema:
 190           $ref: "../swagger.yaml#/definitions/error"
 191       403:
 192         description: access forbidden
 193         schema:
 194           $ref: "../swagger.yaml#/definitions/error"
 195       404:
 196         description: ressource not found
 197         schema:
 198           $ref: "../swagger.yaml#/definitions/error"
 199       409:
 200         description: conflict in updating resource
 201         schema:
 202           $ref: "../swagger.yaml#/definitions/error"
 203       413:
 204         description: Payload too large
 205         schema:
 206           $ref: "../swagger.yaml#/definitions/error"
 207       500:
 208         description: |-
 209           internal server error. possible `error_code` attribute values:
 210           * `internal_server_error`
 211         schema:
 212           $ref: "../swagger.yaml#/definitions/error"
 213       503:
 214         description: under maintenance
 215         schema:
 216           $ref: "../swagger.yaml#/definitions/error"
 217     x-koha-authorization:
 218       permissions:
 219         erm: 1
 220   delete:
 221     x-mojo-to: ERM::DefaultUsageReports#delete
 222     operationId: deleteERMDefaultUsageReports
 223     tags:
 224       - default_usage_report
 225     summary: Delete default_usage_report
 226     produces:
 227       - application/json
 228     parameters:
 229       - $ref: "../swagger.yaml#/parameters/erm_default_usage_report_id_pp"
 230     responses:
 231       204:
 232         description: default_usage_report deleted
 233       400:
 234         description: default_usage_report deletion failed
 235         schema:
 236           $ref: "../swagger.yaml#/definitions/error"
 237       401:
 238         description: authentication required
 239         schema:
 240           $ref: "../swagger.yaml#/definitions/error"
 241       403:
 242         description: access forbidden
 243         schema:
 244           $ref: "../swagger.yaml#/definitions/error"
 245       404:
 246         description: ressource not found
 247         schema:
 248           $ref: "../swagger.yaml#/definitions/error"
 249       409:
 250         description: conflict in deleting resource
 251         schema:
 252           $ref: "../swagger.yaml#/definitions/error"
 253       500:
 254         description: |-
 255           internal server error. possible `error_code` attribute values:
 256           * `internal_server_error`
 257         schema:
 258           $ref: "../swagger.yaml#/definitions/error"
 259       503:
 260         description: under maintenance
 261         schema:
 262           $ref: "../swagger.yaml#/definitions/error"
 263     x-koha-authorization:
 264       permissions:
 265         erm: 1