{ "/checkouts": { "get": { "x-mojo-to": "Checkouts#list", "operationId": "listCheckouts", "tags": ["checkouts"], "summary": "List checkouts", "parameters": [{ "$ref": "../parameters.json#/patron_id_qp" }, { "$ref": "../parameters.json#/page" }, { "$ref": "../parameters.json#/per_page" }, { "$ref": "../parameters.json#/match" }, { "$ref": "../parameters.json#/order_by" }, { "$ref": "../parameters.json#/q_param" }, { "$ref": "../parameters.json#/q_body" }, { "$ref": "../parameters.json#/q_header" },{ "name": "checked_in", "in": "query", "description": "By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.", "type": "boolean" }], "produces": [ "application/json" ], "responses": { "200": { "description": "A list of checkouts", "schema": { "$ref": "../definitions.json#/checkouts" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Patron not found", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "circulate": "circulate_remaining_permissions" } }, "x-koha-embed": [ "issuer" ] } }, "/checkouts/{checkout_id}": { "get": { "x-mojo-to": "Checkouts#get", "operationId": "getCheckout", "tags": ["checkouts"], "summary": "Get checkout", "parameters": [{ "$ref": "../parameters.json#/checkout_id_pp" }], "produces": ["application/json"], "responses": { "200": { "description": "Updated borrower's checkout", "schema": { "$ref": "../definitions.json#/checkout" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Checkout not found", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "circulate": "circulate_remaining_permissions" } }, "x-koha-embed": [ "issuer" ] } }, "/checkouts/{checkout_id}/renewal": { "post": { "x-mojo-to": "Checkouts#renew", "operationId": "renewCheckout", "tags": ["checkouts"], "summary": "Renew a checkout", "parameters": [ { "$ref": "../parameters.json#/checkout_id_pp" }, { "$ref": "../parameters.json#/seen_pp" } ], "produces": ["application/json"], "responses": { "201": { "description": "Updated borrower's checkout", "schema": { "$ref": "../definitions.json#/checkout" } }, "403": { "description": "Cannot renew checkout", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Checkout not found", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "circulate": "circulate_remaining_permissions" } } } }, "/checkouts/{checkout_id}/allows_renewal": { "get": { "x-mojo-to": "Checkouts#allows_renewal", "operationId": "allows_renewalCheckout", "tags": ["checkouts"], "summary": "Get renewability for a checkout", "parameters": [{ "$ref": "../parameters.json#/checkout_id_pp" }], "produces": ["application/json"], "responses": { "200": { "description": "Checkout renewability information", "schema": { "$ref": "../definitions.json#/allows_renewal" } }, "403": { "description": "Forbidden", "schema": { "$ref": "../definitions.json#/error" } }, "404": { "description": "Checkout not found", "schema": { "$ref": "../definitions.json#/error" } } }, "x-koha-authorization": { "permissions": { "circulate": "circulate_remaining_permissions" } } } } }