api/v1/swagger/paths/ill_requests.yaml

   1 ---
   2 /ill/requests:
   3   get:
   4     x-mojo-to: Illrequests#list
   5     operationId: listIllrequests
   6     tags:
   7       - ill_requests
   8     summary: List ILL requests
   9     parameters:
  10       - $ref: "../swagger.yaml#/parameters/page"
  11       - $ref: "../swagger.yaml#/parameters/per_page"
  12       - $ref: "../swagger.yaml#/parameters/match"
  13       - $ref: "../swagger.yaml#/parameters/order_by"
  14       - $ref: "../swagger.yaml#/parameters/q_param"
  15       - $ref: "../swagger.yaml#/parameters/q_body"
  16       - $ref: "../swagger.yaml#/parameters/q_header"
  17       - $ref: "../swagger.yaml#/parameters/request_id_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             - +strings
  27             - biblio
  28             - comments
  29             - comments+count
  30             - extended_attributes
  31             - library
  32             - id_prefix
  33             - patron
  34         collectionFormat: csv
  35     produces:
  36       - application/json
  37     responses:
  38       "200":
  39         description: A list of ILL requests
  40         schema:
  41           type: array
  42           items:
  43             $ref: "../swagger.yaml#/definitions/ill_request"
  44       "403":
  45         description: Access forbidden
  46         schema:
  47           $ref: "../swagger.yaml#/definitions/error"
  48       "404":
  49         description: Patron not found
  50         schema:
  51           $ref: "../swagger.yaml#/definitions/error"
  52       "500":
  53         description: |
  54           Internal server error. Possible `error_code` attribute values:
  55
  56           * `internal_server_error`
  57         schema:
  58           $ref: "../swagger.yaml#/definitions/error"
  59       "503":
  60         description: Under maintenance
  61         schema:
  62           $ref: "../swagger.yaml#/definitions/error"
  63     x-koha-authorization:
  64       permissions:
  65         ill: "1"