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