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   "smtp_server_id_pp": {
  36     "$ref": "parameters/smtp_server.json#/smtp_server_id_pp"
  37   },
  38   "vendoridPathParam": {
  39     "$ref": "parameters/vendor.json#/vendoridPathParam"
  40   },
  41   "checkout_id_pp": {
  42     "$ref": "parameters/checkout.json#/checkout_id_pp"
  43   },
  44   "seen_pp": {
  45     "$ref": "parameters/checkout.json#/seen_pp"
  46   },
  47   "match": {
  48     "name": "_match",
  49     "in": "query",
  50     "required": false,
  51     "description": "Matching criteria",
  52     "type": "string",
  53     "enum": [
  54         "contains",
  55         "exact",
  56         "starts_with",
  57         "ends_with"
  58     ]
  59   },
  60   "order_by": {
  61     "name": "_order_by",
  62     "in": "query",
  63     "required": false,
  64     "description": "Sorting criteria",
  65     "type": "array",
  66     "collectionFormat": "pipes",
  67     "items": {
  68         "type": "string"
  69     }
  70   },
  71   "page": {
  72     "name": "_page",
  73     "in": "query",
  74     "required": false,
  75     "description": "Page number, for paginated object listing",
  76     "type": "integer"
  77   },
  78   "per_page": {
  79     "name": "_per_page",
  80     "in": "query",
  81     "required": false,
  82     "description": "Page size, for paginated object listing",
  83     "type": "integer"
  84   },
  85   "q_body": {
  86     "name": "query",
  87     "in": "body",
  88     "required": false,
  89     "description": "Query filter sent through request's body",
  90     "schema": {
  91       "type": ["object", "array"]
  92     }
  93   },
  94   "q_param": {
  95     "name": "q",
  96     "in": "query",
  97     "required": false,
  98     "description": "Query filter sent as a request parameter",
  99     "type": "string"
 100   },
 101   "q_header": {
 102     "name": "x-koha-query",
 103     "in": "header",
 104     "required": false,
 105     "description": "Query filter sent as a request header",
 106     "type": "string"
 107   },
 108   "fundidPathParam": {
 109     "$ref": "parameters/fund.json#/fundidPathParam"
 110   }
 111 }