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