{ "/acquisitions/orders": { "get": { "x-mojo-to": "Acquisitions::Orders#list", "operationId": "listOrders", "tags": ["orders"], "summary": "List orders", "produces": [ "application/json" ], "parameters": [ { "name": "biblio_id", "in": "query", "description": "Identifier for a linked bibliographic record", "required": false, "type": "integer" }, { "name": "basket_id", "in": "query", "description": "Identifier for a linked acquisition basket", "required": false, "type": "integer" }, { "name": "fund_id", "in": "query", "description": "Identifier for the fund the order goes against", "required": false, "type": "integer" }, { "name": "status", "in": "query", "description": "Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'", "required": false, "type": "string" }, { "name": "only_active", "in": "query", "description": "If only active orders should be listed", "required": false, "type": "boolean" }, { "$ref": "../parameters.json#/match" }, { "$ref": "../parameters.json#/order_by" }, { "$ref": "../parameters.json#/page" }, { "$ref": "../parameters.json#/per_page" }, { "$ref": "../parameters.json#/q_param" }, { "$ref": "../parameters.json#/q_body" }, { "$ref": "../parameters.json#/q_header" } ], "responses": { "200": { "description": "A list of orders", "schema": { "type": "array", "items": { "$ref": "../definitions.json#/order" } } }, "401": { "description": "Authentication required", "schema": { "$ref": "../definitions.json#/error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Order not found", "schema": { "$ref": "../definitions.json#/error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "../definitions.json#/error" } }, "503": { "description": "Under maintenance", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "acquisition": [ "order_manage", "order_manage_all" ] } }, "x-koha-embed": [ "basket", "basket.basket_group", "basket.creator", "biblio", "biblio.active_orders+count", "biblio.holds+count", "biblio.items+count", "biblio.suggestions.suggester", "fund", "current_item_level_holds+count", "invoice", "items", "subscription" ] }, "post": { "x-mojo-to": "Acquisitions::Orders#add", "operationId": "addOrder", "tags": ["orders"], "summary": "Add order", "parameters": [ { "name": "body", "in": "body", "description": "A JSON object representing an order", "required": true, "schema": { "$ref": "../definitions.json#/order" } } ], "produces": [ "application/json" ], "responses": { "201": { "description": "Order added", "schema": { "$ref": "../definitions.json#/order" } }, "400": { "description": "Bad request", "schema": { "$ref": "../definitions.json#/error" } }, "401": { "description": "Authentication required", "schema": { "$ref": "../definitions.json#/error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "409": { "description": "Conflict in creating the resource", "schema": { "$ref": "../definitions.json#/error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "../definitions.json#/error" } }, "503": { "description": "Under maintenance", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "acquisition": "order_manage" } } } }, "/acquisitions/orders/{order_id}": { "get": { "x-mojo-to": "Acquisitions::Orders#get", "operationId": "getOrder", "tags": ["orders"], "summary": "Get order", "parameters": [ { "$ref": "../parameters.json#/order_id_pp" } ], "produces": [ "application/json" ], "responses": { "200": { "description": "An order", "schema": { "$ref": "../definitions.json#/order" } }, "401": { "description": "Authentication required", "schema": { "$ref": "../definitions.json#/error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Order not found", "schema": { "$ref": "../definitions.json#/error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "../definitions.json#/error" } }, "503": { "description": "Under maintenance", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "acquisition": "order_manage" } }, "x-koha-embed": [ "basket", "basket.basket_group", "basket.creator", "biblio", "biblio.active_orders+count", "biblio.holds+count", "biblio.items+count", "biblio.suggestions.suggester", "fund", "current_item_level_holds+count", "invoice", "items", "subscription" ] }, "put": { "x-mojo-to": "Acquisitions::Orders#update", "operationId": "updateOrder", "tags": ["orders"], "summary": "Update order", "parameters": [ { "$ref": "../parameters.json#/order_id_pp" }, { "name": "body", "in": "body", "description": "A JSON object representing an order", "required": true, "schema": { "$ref": "../definitions.json#/order" } } ], "produces": [ "application/json" ], "responses": { "200": { "description": "An order", "schema": { "$ref": "../definitions.json#/order" } }, "401": { "description": "Authentication required", "schema": { "$ref": "../definitions.json#/error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Order not found", "schema": { "$ref": "../definitions.json#/error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "../definitions.json#/error" } }, "503": { "description": "Under maintenance", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "acquisition": "order_manage" } } }, "delete": { "x-mojo-to": "Acquisitions::Orders#delete", "operationId": "deleteOrder", "tags": ["orders"], "summary": "Delete order", "parameters": [ { "$ref": "../parameters.json#/order_id_pp" } ], "produces": [ "application/json" ], "responses": { "204": { "description": "Order deleted" }, "401": { "description": "Authentication required", "schema": { "$ref": "../definitions.json#/error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Order not found", "schema": { "$ref": "../definitions.json#/error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "../definitions.json#/error" } }, "503": { "description": "Under maintenance", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "acquisition": "order_manage" } } } } }