api/v1/swagger/paths/illrequests.json

   1 {
   2     "/illrequests": {
   3         "get": {
   4             "x-mojo-to": "Illrequests#list",
   5             "operationId": "listIllrequests",
   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                         "library",
  19                         "capabilities",
  20                         "metadata",
  21                         "requested_partners"
  22                     ]
  23                 }
  24             }, {
  25                 "name": "backend",
  26                 "in": "query",
  27                 "description": "The name of a ILL backend",
  28                 "required": false,
  29                 "type": "string"
  30             }, {
  31                 "name": "orderid",
  32                 "in": "query",
  33                 "description": "The order ID of a request",
  34                 "required": false,
  35                 "type": "string"
  36             }, {
  37                 "name": "biblionumber",
  38                 "in": "query",
  39                 "description": "Internal biblio identifier",
  40                 "required": false,
  41                 "type": "integer"
  42             }, {
  43                 "name": "borrowernumber",
  44                 "in": "query",
  45                 "description": "Internal patron identifier",
  46                 "required": false,
  47                 "type": "integer"
  48             }, {
  49                 "name": "completed",
  50                 "in": "query",
  51                 "description": "The date the request was considered completed",
  52                 "required": false,
  53                 "type": "string"
  54             }, {
  55                 "name": "completed_formatted",
  56                 "in": "query",
  57                 "description": "The date the request was considered complete formatted",
  58                 "required": false,
  59                 "type": "string"
  60             }, {
  61                 "name": "status",
  62                 "in": "query",
  63                 "description": "A full status string e.g. REQREV",
  64                 "required": false,
  65                 "type": "string"
  66             }, {
  67                 "name": "cost",
  68                 "in": "query",
  69                 "description": "The quoted cost of the request",
  70                 "required": false,
  71                 "type": "number"
  72             }, {
  73                 "name": "price_paid",
  74                 "in": "query",
  75                 "description": "The final cost of the request",
  76                 "required": false,
  77                 "type": "number"
  78             }, {
  79                 "name": "medium",
  80                 "in": "query",
  81                 "description": "The medium of the requested item",
  82                 "required": false,
  83                 "type": "string"
  84             }, {
  85                 "name": "updated",
  86                 "in": "query",
  87                 "description": "The last updated date of the request",
  88                 "required": false,
  89                 "type": "string"
  90             }, {
  91                 "name": "updated_formatted",
  92                 "in": "query",
  93                 "description": "The last updated date of the request formatted",
  94                 "required": false,
  95                 "type": "string"
  96             }, {
  97                 "name": "placed",
  98                 "in": "query",
  99                 "description": "The date the request was placed",
 100                 "required": false,
 101                 "type": "string"
 102             }, {
 103                 "name": "placed_formatted",
 104                 "in": "query",
 105                 "description": "The date the request was placed formatted",
 106                 "required": false,
 107                 "type": "string"
 108             }, {
 109                 "name": "branchcode",
 110                 "in": "query",
 111                 "description": "Library ID",
 112                 "required": false,
 113                 "type": "string"
 114             }],
 115             "produces": [
 116                 "application/json"
 117             ],
 118             "responses": {
 119                 "200": {
 120                     "description": "A list of ILL requests"
 121                 },
 122                 "401": {
 123                   "description": "Authentication required",
 124                   "schema": {
 125                     "$ref": "../definitions.json#/error"
 126                   }
 127                 },
 128                 "403": {
 129                   "description": "Access forbidden",
 130                   "schema": {
 131                     "$ref": "../definitions.json#/error"
 132                   }
 133                 },
 134                 "404": {
 135                   "description": "ILL requests not found",
 136                   "schema": {
 137                     "$ref": "../definitions.json#/error"
 138                   }
 139                 },
 140                 "500": {
 141                   "description": "Internal server error",
 142                   "schema": {
 143                     "$ref": "../definitions.json#/error"
 144                   }
 145                 },
 146                 "503": {
 147                   "description": "Under maintenance",
 148                   "schema": {
 149                     "$ref": "../definitions.json#/error"
 150                   }
 151                 }
 152             },
 153             "x-koha-authorization": {
 154                 "permissions": {
 155                     "ill": "1"
 156                 }
 157             }
 158         }
 159     }
 160 }