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