koha-dev.rot13.org Git - srvgit/blob - api/v1/swagger/paths/erm_users.yaml

   1 ---
   2 /erm/users:
   3   get:
   4     x-mojo-to: ERM#list_users
   5     operationId: listERMUsers
   6     description: This resource returns a list of patron allowed to be users of the ERM module
   7     summary: List possibe users for ERM
   8     tags:
   9       - ERM
  10     parameters:
  11       - $ref: "../swagger.yaml#/parameters/match"
  12       - $ref: "../swagger.yaml#/parameters/order_by"
  13       - $ref: "../swagger.yaml#/parameters/page"
  14       - $ref: "../swagger.yaml#/parameters/per_page"
  15       - $ref: "../swagger.yaml#/parameters/q_param"
  16       - $ref: "../swagger.yaml#/parameters/q_body"
  17       - $ref: "../swagger.yaml#/parameters/q_header"
  18     produces:
  19       - application/json
  20     responses:
  21       200:
  22         description: A list of ERM' users
  23         schema:
  24           type: array
  25           items:
  26             $ref: "../swagger.yaml#/definitions/patron"
  27       400:
  28         description: Bad request
  29         schema:
  30           $ref: "../swagger.yaml#/definitions/error"
  31       403:
  32         description: Access forbidden
  33         schema:
  34           $ref: "../swagger.yaml#/definitions/error"
  35       500:
  36         description: |
  37           Internal server error. Possible `error_code` attribute values:
  38
  39           * `internal_server_error`
  40         schema:
  41           $ref: "../swagger.yaml#/definitions/error"
  42       503:
  43         description: Under maintenance
  44         schema:
  45           $ref: "../swagger.yaml#/definitions/error"
  46     x-koha-authorization:
  47       permissions:
  48         erm: 1
  49     x-koha-embed:
  50       - extended_attributes
  51