api/v1/swagger/parameters.json

   1 {
   2   "biblio_id_pp": {
   3     "$ref": "parameters/biblio.json#/biblio_id_pp"
   4   },
   5   "advancededitormacro_id_pp": {
   6     "$ref": "parameters/advancededitormacro.json#/advancededitormacro_id_pp"
   7   },
   8   "patron_id_pp": {
   9     "$ref": "parameters/patron.json#/patron_id_pp"
  10   },
  11   "transfer_limit_id_pp": {
  12     "$ref": "parameters/transfer_limit.json#/transfer_limit_id_pp"
  13   },
  14   "patron_id_qp": {
  15     "$ref": "parameters/patron.json#/patron_id_qp"
  16   },
  17   "import_batch_profile_id_pp": {
  18     "$ref": "parameters/import_batch_profile.json#/import_batch_profile_id_pp"
  19   },
  20   "city_id_pp": {
  21     "$ref": "parameters/city.json#/city_id_pp"
  22   },
  23   "hold_id_pp": {
  24     "$ref": "parameters/hold.json#/hold_id_pp"
  25   },
  26   "club_id_pp": {
  27     "$ref": "parameters/club.json#/club_id_pp"
  28   },
  29   "library_id_pp": {
  30     "$ref": "parameters/library.json#/library_id_pp"
  31   },
  32   "item_id_pp": {
  33     "$ref": "parameters/item.json#/item_id_pp"
  34   },
  35   "order_id_pp": {
  36     "$ref": "parameters/order.json#/order_id_pp"
  37   },
  38   "quote_id_pp": {
  39     "$ref": "parameters/quote.json#/quote_id_pp"
  40   },
  41   "smtp_server_id_pp": {
  42     "$ref": "parameters/smtp_server.json#/smtp_server_id_pp"
  43   },
  44   "vendoridPathParam": {
  45     "$ref": "parameters/vendor.json#/vendoridPathParam"
  46   },
  47   "checkout_id_pp": {
  48     "$ref": "parameters/checkout.json#/checkout_id_pp"
  49   },
  50   "seen_pp": {
  51     "$ref": "parameters/checkout.json#/seen_pp"
  52   },
  53   "cash_register_id_pp": {
  54     "$ref": "parameters/cash_register.json#/cash_register_id_pp"
  55   },
  56   "cashup_id_pp": {
  57     "$ref": "parameters/cashup.json#/cashup_id_pp"
  58   },
  59   "ar_id_pp": {
  60     "$ref": "parameters/article_request.json#/ar_id_pp"
  61   },
  62   "ar_reason_qp": {
  63     "$ref": "parameters/article_request.json#/ar_reason_qp"
  64   },
  65   "ar_notes_qp": {
  66     "$ref": "parameters/article_request.json#/ar_notes_qp"
  67   },
  68   "match": {
  69     "name": "_match",
  70     "in": "query",
  71     "required": false,
  72     "description": "Matching criteria",
  73     "type": "string",
  74     "enum": [
  75         "contains",
  76         "exact",
  77         "starts_with",
  78         "ends_with"
  79     ]
  80   },
  81   "order_by": {
  82     "name": "_order_by",
  83     "in": "query",
  84     "required": false,
  85     "description": "Sorting criteria",
  86     "type": "array",
  87     "collectionFormat": "csv",
  88     "items": {
  89         "type": "string"
  90     }
  91   },
  92   "page": {
  93     "name": "_page",
  94     "in": "query",
  95     "required": false,
  96     "description": "Page number, for paginated object listing",
  97     "type": "integer"
  98   },
  99   "per_page": {
 100     "name": "_per_page",
 101     "in": "query",
 102     "required": false,
 103     "description": "Page size, for paginated object listing",
 104     "type": "integer"
 105   },
 106   "q_body": {
 107     "name": "query",
 108     "in": "body",
 109     "required": false,
 110     "description": "Query filter sent through request's body",
 111     "schema": {
 112       "type": ["object", "array"]
 113     }
 114   },
 115   "q_param": {
 116     "name": "q",
 117     "in": "query",
 118     "required": false,
 119     "description": "Query filter sent as a request parameter",
 120     "type": "string"
 121   },
 122   "q_header": {
 123     "name": "x-koha-query",
 124     "in": "header",
 125     "required": false,
 126     "description": "Query filter sent as a request header",
 127     "type": "string"
 128   },
 129   "fundidPathParam": {
 130     "$ref": "parameters/fund.json#/fundidPathParam"
 131   }
 132 }