Bug 20942: OpenAPI spec for /patrons/{patron_id}/account
[koha.git] / api / v1 / swagger / paths / patrons_account.json
1 {
2   "/patrons/{patron_id}/account": {
3     "get": {
4       "x-mojo-to": "Patrons::Account#get",
5       "operationId": "getPatronAccount",
6       "tags": [
7         "patron"
8       ],
9       "parameters": [
10         {
11           "$ref": "../parameters.json#/patron_id_pp"
12         }
13       ],
14       "produces": [
15         "application/json"
16       ],
17       "responses": {
18         "200": {
19           "description": "Patron's account balance",
20           "schema": {
21             "$ref": "../definitions.json#/patron_balance"
22           }
23         },
24         "401": {
25           "description": "Authentication required",
26           "schema": {
27             "$ref": "../definitions.json#/error"
28           }
29         },
30         "403": {
31           "description": "Access forbidden",
32           "schema": {
33             "$ref": "../definitions.json#/error"
34           }
35         },
36         "404": {
37           "description": "Patron not found",
38           "schema": {
39             "$ref": "../definitions.json#/error"
40           }
41         },
42         "500": {
43           "description": "Internal server error",
44           "schema": {
45             "$ref": "../definitions.json#/error"
46           }
47         },
48         "503": {
49           "description": "Under maintenance",
50           "schema": {
51             "$ref": "../definitions.json#/error"
52           }
53         }
54       },
55       "x-koha-authorization": {
56         "allow-owner": true,
57         "allow-guarantor": true,
58         "permissions": {
59           "borrowers": "edit_borrowers",
60           "updatecharges": "remaining_permissions"
61         }
62       }
63     }
64   }
65 }