api/v1/swagger/paths/illrequests.json

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