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