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       - name: x-koha-embed
  19         in: header
  20         required: false
  21         description: Embed list sent as a request header
  22         type: array
  23         items:
  24           type: string
  25           enum:
  26             - extended_attributes
  27         collectionFormat: csv
  28     produces:
  29       - application/json
  30     responses:
  31       200:
  32         description: A list of ERM' users
  33         schema:
  34           type: array
  35           items:
  36             $ref: "../swagger.yaml#/definitions/patron"
  37       400:
  38         description: Bad request
  39         schema:
  40           $ref: "../swagger.yaml#/definitions/error"
  41       403:
  42         description: Access forbidden
  43         schema:
  44           $ref: "../swagger.yaml#/definitions/error"
  45       500:
  46         description: |
  47           Internal server error. Possible `error_code` attribute values:
  48
  49           * `internal_server_error`
  50         schema:
  51           $ref: "../swagger.yaml#/definitions/error"
  52       503:
  53         description: Under maintenance
  54         schema:
  55           $ref: "../swagger.yaml#/definitions/error"
  56     x-koha-authorization:
  57       permissions:
  58         erm: 1
  59