api/v1/swagger/paths/illrequests.json

   1 {
   2     "/illrequests": {
   3         "get": {
   4             "x-mojo-controller": "Koha::REST::V1::Illrequests",
   5             "operationId": "list",
   6             "tags": ["illrequests"],
   7             "parameters": [{
   8                 "name": "embed",
   9                 "in": "query",
  10                 "description": "Additional objects that should be embedded in the response",
  11                 "required": false,
  12                 "type": "array",
  13                 "collectionFormat": "csv",
  14                 "items": {
  15                     "type": "string",
  16                     "enum": [
  17                         "patron",
  18                         "branch",
  19                         "capabilities"
  20                     ]
  21                 }
  22             }, {
  23                 "name": "backend",
  24                 "in": "query",
  25                 "description": "The name of a ILL backend",
  26                 "required": false,
  27                 "type": "string"
  28             }, {
  29                 "name": "orderid",
  30                 "in": "query",
  31                 "description": "The order ID of a request",
  32                 "required": false,
  33                 "type": "string"
  34             }, {
  35                 "name": "biblio_id",
  36                 "in": "query",
  37                 "description": "The biblio ID associated with a request",
  38                 "required": false,
  39                 "type": "integer"
  40             }, {
  41                 "name": "borrower_id",
  42                 "in": "query",
  43                 "description": "The borrower ID associated with a request",
  44                 "required": false,
  45                 "type": "integer"
  46             }, {
  47                 "name": "completed",
  48                 "in": "query",
  49                 "description": "The date the request was considered completed",
  50                 "required": false,
  51                 "type": "string"
  52             }, {
  53                 "name": "status",
  54                 "in": "query",
  55                 "description": "A full status string e.g. REQREV",
  56                 "required": false,
  57                 "type": "string"
  58             }, {
  59                 "name": "medium",
  60                 "in": "query",
  61                 "description": "The medium of the requested item",
  62                 "required": false,
  63                 "type": "string"
  64             }, {
  65                 "name": "updated",
  66                 "in": "query",
  67                 "description": "The last updated date of the request",
  68                 "required": false,
  69                 "type": "string"
  70             }, {
  71                 "name": "placed",
  72                 "in": "query",
  73                 "description": "The date the request was placed",
  74                 "required": false,
  75                 "type": "string"
  76             }, {
  77                 "name": "branch_id",
  78                 "in": "query",
  79                 "description": "The ID of the pickup branch",
  80                 "required": false,
  81                 "type": "string"
  82             }],
  83             "produces": [
  84                 "application/json"
  85             ],
  86             "responses": {
  87                 "200": {
  88                     "description": "OK"
  89                 }
  90             },
  91             "x-koha-authorization": {
  92                 "permissions": {
  93                     "borrowers": "1"
  94                 }
  95             }
  96         }
  97     }
  98 }