Bug 19618: Add api endpoint for club holds
[koha.git] / api / v1 / swagger / parameters.json
1 {
2   "biblio_id_pp": {
3     "$ref": "parameters/biblio.json#/biblio_id_pp"
4   },
5   "patron_id_pp": {
6     "$ref": "parameters/patron.json#/patron_id_pp"
7   },
8   "patron_id_qp": {
9     "$ref": "parameters/patron.json#/patron_id_qp"
10   },
11   "city_id_pp": {
12     "$ref": "parameters/city.json#/city_id_pp"
13   },
14   "hold_id_pp": {
15     "$ref": "parameters/hold.json#/hold_id_pp"
16   },
17   "club_id_pp": {
18     "$ref": "parameters/club.json#/club_id_pp"
19   },
20   "library_id_pp": {
21     "$ref": "parameters/library.json#/library_id_pp"
22   },
23   "item_id_pp": {
24     "$ref": "parameters/item.json#/item_id_pp"
25   },
26   "vendoridPathParam": {
27     "$ref": "parameters/vendor.json#/vendoridPathParam"
28   },
29   "checkout_id_pp": {
30     "$ref": "parameters/checkout.json#/checkout_id_pp"
31   },
32   "match": {
33     "name": "_match",
34     "in": "query",
35     "required": false,
36     "description": "Matching criteria",
37     "type": "string",
38     "enum": [
39         "contains",
40         "exact",
41         "starts_with",
42         "ends_with"
43     ]
44   },
45   "order_by": {
46     "name": "_order_by",
47     "in": "query",
48     "required": false,
49     "description": "Sorting criteria",
50     "type": "array",
51     "collectionFormat": "pipes",
52     "items": {
53         "type": "string"
54     }
55   },
56   "page": {
57     "name": "_page",
58     "in": "query",
59     "required": false,
60     "description": "Page number, for paginated object listing",
61     "type": "integer"
62   },
63   "per_page": {
64     "name": "_per_page",
65     "in": "query",
66     "required": false,
67     "description": "Page size, for paginated object listing",
68     "type": "integer"
69    },
70   "fundidPathParam": {
71     "$ref": "parameters/fund.json#/fundidPathParam"
72   }
73 }