api/v1/swagger/paths/acquisitions_orders.yaml

   1 ---
   2 /acquisitions/orders:
   3   get:
   4     x-mojo-to: Acquisitions::Orders#list
   5     operationId: listOrders
   6     tags:
   7       - orders
   8     summary: List orders
   9     produces:
  10       - application/json
  11     parameters:
  12       - name: biblio_id
  13         in: query
  14         description: Identifier for a linked bibliographic record
  15         required: false
  16         type: integer
  17       - name: basket_id
  18         in: query
  19         description: Identifier for a linked acquisition basket
  20         required: false
  21         type: integer
  22       - name: fund_id
  23         in: query
  24         description: Identifier for the fund the order goes against
  25         required: false
  26         type: integer
  27       - name: status
  28         in: query
  29         description: Current status for the order. Can be 'new', 'ordered', 'partial',
  30           'complete' or 'cancelled'
  31         required: false
  32         type: string
  33       - name: only_active
  34         in: query
  35         description: If only active orders should be listed
  36         required: false
  37         type: boolean
  38       - $ref: "../swagger.yaml#/parameters/match"
  39       - $ref: "../swagger.yaml#/parameters/order_by"
  40       - $ref: "../swagger.yaml#/parameters/page"
  41       - $ref: "../swagger.yaml#/parameters/per_page"
  42       - $ref: "../swagger.yaml#/parameters/q_param"
  43       - $ref: "../swagger.yaml#/parameters/q_body"
  44       - $ref: "../swagger.yaml#/parameters/q_header"
  45       - $ref: "../swagger.yaml#/parameters/request_id_header"
  46       - name: x-koha-embed
  47         in: header
  48         required: false
  49         description: Embed list sent as a request header
  50         type: array
  51         items:
  52           type: string
  53           enum:
  54             - basket
  55             - basket.basket_group
  56             - basket.creator
  57             - biblio
  58             - biblio.active_orders+count
  59             - biblio.holds+count
  60             - biblio.items+count
  61             - biblio.suggestions.suggester
  62             - creator
  63             - fund
  64             - fund.budget
  65             - current_item_level_holds+count
  66             - invoice
  67             - items
  68             - items+strings
  69             - subscription
  70         collectionFormat: csv
  71     responses:
  72       "200":
  73         description: A list of orders
  74         schema:
  75           type: array
  76           items:
  77             $ref: "../swagger.yaml#/definitions/order"
  78       "401":
  79         description: Authentication required
  80         schema:
  81           $ref: "../swagger.yaml#/definitions/error"
  82       "403":
  83         description: Access forbidden
  84         schema:
  85           $ref: "../swagger.yaml#/definitions/error"
  86       "404":
  87         description: Order not found
  88         schema:
  89           $ref: "../swagger.yaml#/definitions/error"
  90       "500":
  91         description: |
  92           Internal server error. Possible `error_code` attribute values:
  93
  94           * `internal_server_error`
  95         schema:
  96           $ref: "../swagger.yaml#/definitions/error"
  97       "503":
  98         description: Under maintenance
  99         schema:
 100           $ref: "../swagger.yaml#/definitions/error"
 101     x-koha-authorization:
 102       permissions:
 103         acquisition:
 104           - order_manage
 105           - order_manage_all
 106   post:
 107     x-mojo-to: Acquisitions::Orders#add
 108     operationId: addOrder
 109     tags:
 110       - orders
 111     summary: Add order
 112     parameters:
 113       - name: body
 114         in: body
 115         description: A JSON object representing an order
 116         required: true
 117         schema:
 118           $ref: "../swagger.yaml#/definitions/order"
 119     produces:
 120       - application/json
 121     responses:
 122       "201":
 123         description: Order added
 124         schema:
 125           $ref: "../swagger.yaml#/definitions/order"
 126       "400":
 127         description: Bad request
 128         schema:
 129           $ref: "../swagger.yaml#/definitions/error"
 130       "401":
 131         description: Authentication required
 132         schema:
 133           $ref: "../swagger.yaml#/definitions/error"
 134       "403":
 135         description: Access forbidden
 136         schema:
 137           $ref: "../swagger.yaml#/definitions/error"
 138       "409":
 139         description: Conflict in creating the resource
 140         schema:
 141           $ref: "../swagger.yaml#/definitions/error"
 142       "500":
 143         description: |
 144           Internal server error. Possible `error_code` attribute values:
 145
 146           * `internal_server_error`
 147         schema:
 148           $ref: "../swagger.yaml#/definitions/error"
 149       "503":
 150         description: Under maintenance
 151         schema:
 152           $ref: "../swagger.yaml#/definitions/error"
 153     x-koha-authorization:
 154       permissions:
 155         acquisition: order_manage
 156 "/acquisitions/orders/{order_id}":
 157   get:
 158     x-mojo-to: Acquisitions::Orders#get
 159     operationId: getOrder
 160     tags:
 161       - orders
 162     summary: Get order
 163     parameters:
 164       - $ref: "../swagger.yaml#/parameters/order_id_pp"
 165       - name: x-koha-embed
 166         in: header
 167         required: false
 168         description: Embed list sent as a request header
 169         type: array
 170         items:
 171           type: string
 172           enum:
 173             - basket
 174             - basket.basket_group
 175             - basket.creator
 176             - biblio
 177             - biblio.active_orders+count
 178             - biblio.holds+count
 179             - biblio.items+count
 180             - biblio.suggestions.suggester
 181             - fund
 182             - current_item_level_holds+count
 183             - invoice
 184             - items
 185             - subscription
 186         collectionFormat: csv
 187     produces:
 188       - application/json
 189     responses:
 190       "200":
 191         description: An order
 192         schema:
 193           $ref: "../swagger.yaml#/definitions/order"
 194       "401":
 195         description: Authentication required
 196         schema:
 197           $ref: "../swagger.yaml#/definitions/error"
 198       "403":
 199         description: Access forbidden
 200         schema:
 201           $ref: "../swagger.yaml#/definitions/error"
 202       "404":
 203         description: Order not found
 204         schema:
 205           $ref: "../swagger.yaml#/definitions/error"
 206       "500":
 207         description: |
 208           Internal server error. Possible `error_code` attribute values:
 209
 210           * `internal_server_error`
 211         schema:
 212           $ref: "../swagger.yaml#/definitions/error"
 213       "503":
 214         description: Under maintenance
 215         schema:
 216           $ref: "../swagger.yaml#/definitions/error"
 217     x-koha-authorization:
 218       permissions:
 219         acquisition: order_manage
 220   put:
 221     x-mojo-to: Acquisitions::Orders#update
 222     operationId: updateOrder
 223     tags:
 224       - orders
 225     summary: Update order
 226     parameters:
 227       - $ref: "../swagger.yaml#/parameters/order_id_pp"
 228       - name: body
 229         in: body
 230         description: A JSON object representing an order
 231         required: true
 232         schema:
 233           $ref: "../swagger.yaml#/definitions/order"
 234     produces:
 235       - application/json
 236     responses:
 237       "200":
 238         description: An order
 239         schema:
 240           $ref: "../swagger.yaml#/definitions/order"
 241       "401":
 242         description: Authentication required
 243         schema:
 244           $ref: "../swagger.yaml#/definitions/error"
 245       "403":
 246         description: Access forbidden
 247         schema:
 248           $ref: "../swagger.yaml#/definitions/error"
 249       "404":
 250         description: Order not found
 251         schema:
 252           $ref: "../swagger.yaml#/definitions/error"
 253       "500":
 254         description: |
 255           Internal server error. Possible `error_code` attribute values:
 256
 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         acquisition: order_manage
 267   delete:
 268     x-mojo-to: Acquisitions::Orders#delete
 269     operationId: deleteOrder
 270     tags:
 271       - orders
 272     summary: Delete order
 273     parameters:
 274       - $ref: "../swagger.yaml#/parameters/order_id_pp"
 275     produces:
 276       - application/json
 277     responses:
 278       "204":
 279         description: Order deleted
 280       "401":
 281         description: Authentication required
 282         schema:
 283           $ref: "../swagger.yaml#/definitions/error"
 284       "403":
 285         description: Access forbidden
 286         schema:
 287           $ref: "../swagger.yaml#/definitions/error"
 288       "404":
 289         description: Order not found
 290         schema:
 291           $ref: "../swagger.yaml#/definitions/error"
 292       "500":
 293         description: |
 294           Internal server error. Possible `error_code` attribute values:
 295
 296           * `internal_server_error`
 297         schema:
 298           $ref: "../swagger.yaml#/definitions/error"
 299       "503":
 300         description: Under maintenance
 301         schema:
 302           $ref: "../swagger.yaml#/definitions/error"
 303     x-koha-authorization:
 304       permissions:
 305         acquisition: order_manage