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                         "branch",
  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": "biblio_id",
  37                 "in": "query",
  38                 "description": "The biblio ID associated with a request",
  39                 "required": false,
  40                 "type": "integer"
  41             }, {
  42                 "name": "borrower_id",
  43                 "in": "query",
  44                 "description": "The borrower ID associated with a request",
  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": "status",
  55                 "in": "query",
  56                 "description": "A full status string e.g. REQREV",
  57                 "required": false,
  58                 "type": "string"
  59             }, {
  60                 "name": "medium",
  61                 "in": "query",
  62                 "description": "The medium of the requested item",
  63                 "required": false,
  64                 "type": "string"
  65             }, {
  66                 "name": "updated",
  67                 "in": "query",
  68                 "description": "The last updated date of the request",
  69                 "required": false,
  70                 "type": "string"
  71             }, {
  72                 "name": "placed",
  73                 "in": "query",
  74                 "description": "The date the request was placed",
  75                 "required": false,
  76                 "type": "string"
  77             }, {
  78                 "name": "branch_id",
  79                 "in": "query",
  80                 "description": "The ID of the pickup branch",
  81                 "required": false,
  82                 "type": "string"
  83             }],
  84             "produces": [
  85                 "application/json"
  86             ],
  87             "responses": {
  88                 "200": {
  89                     "description": "A list of ILL requests"
  90                 },
  91                 "401": {
  92                   "description": "Authentication required",
  93                   "schema": {
  94                     "$ref": "../definitions.json#/error"
  95                   }
  96                 },
  97                 "403": {
  98                   "description": "Access forbidden",
  99                   "schema": {
 100                     "$ref": "../definitions.json#/error"
 101                   }
 102                 },
 103                 "404": {
 104                   "description": "ILL requests not found",
 105                   "schema": {
 106                     "$ref": "../definitions.json#/error"
 107                   }
 108                 },
 109                 "500": {
 110                   "description": "Internal server error",
 111                   "schema": {
 112                     "$ref": "../definitions.json#/error"
 113                   }
 114                 },
 115                 "503": {
 116                   "description": "Under maintenance",
 117                   "schema": {
 118                     "$ref": "../definitions.json#/error"
 119                   }
 120                 }
 121             },
 122             "x-koha-authorization": {
 123                 "permissions": {
 124                     "ill": "1"
 125                 }
 126             }
 127         }
 128     }
 129 }