api/v1/swagger/paths/erm_default_usage_reports.yaml

   1 ---
   2 /erm/default_usage_reports:
   3   get:
   4     x-mojo-to: ERM::EUsage::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::EUsage::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   delete:
 123     x-mojo-to: ERM::EUsage::DefaultUsageReports#delete
 124     operationId: deleteERMDefaultUsageReports
 125     tags:
 126       - default_usage_report
 127     summary: Delete default_usage_report
 128     produces:
 129       - application/json
 130     parameters:
 131       - $ref: "../swagger.yaml#/parameters/erm_default_usage_report_id_pp"
 132     responses:
 133       204:
 134         description: default_usage_report deleted
 135       400:
 136         description: default_usage_report deletion failed
 137         schema:
 138           $ref: "../swagger.yaml#/definitions/error"
 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       409:
 152         description: conflict in deleting resource
 153         schema:
 154           $ref: "../swagger.yaml#/definitions/error"
 155       500:
 156         description: |-
 157           internal server error. possible `error_code` attribute values:
 158           * `internal_server_error`
 159         schema:
 160           $ref: "../swagger.yaml#/definitions/error"
 161       503:
 162         description: under maintenance
 163         schema:
 164           $ref: "../swagger.yaml#/definitions/error"
 165     x-koha-authorization:
 166       permissions:
 167         erm: 1