api/v1/swagger/definitions/ill_request.yaml

   1 ---
   2 type: object
   3 properties:
   4   ill_request_id:
   5     type: integer
   6     description: Internal ILL request identifier
   7   biblio_id:
   8     type:
   9       - integer
  10       - "null"
  11     description: Internal bibliographic record identifier
  12   ill_batch_id:
  13     type:
  14       - integer
  15       - "null"
  16     description: Batch id this requests belongs to
  17   patron_id:
  18     type:
  19       - integer
  20       - "null"
  21     description: Internal patron id
  22   due_date:
  23     type:
  24       - string
  25       - "null"
  26     format: date-time
  27     description: Date and time the request item should be due when checked out
  28   library_id:
  29     type: string
  30     description: Internal library identifier
  31   requested_date:
  32     type:
  33       - string
  34       - "null"
  35     format: date
  36     description: Date the request was placed by the patron
  37   replied_date:
  38     type:
  39       - string
  40       - "null"
  41     format: date
  42     description: FIXME
  43   timestamp:
  44     type: string
  45     format: date-time
  46     description: Date and time of last object update
  47   completed_date:
  48     type:
  49       - string
  50       - "null"
  51     format: date
  52     description: Date the request was marked as completed
  53   access_url:
  54     type:
  55       - string
  56       - "null"
  57     description: A URL for accessing the item
  58   status:
  59     type: string
  60     description: |
  61       The status the request is at.
  62
  63       Note: This is defined by each backend. Please refer to the specific backend's
  64       documentation or code to understand the possible values.
  65   medium:
  66     type:
  67       - string
  68       - "null"
  69     description: Description of the ILL item medium
  70   cost:
  71     type:
  72       - string
  73       - "null"
  74     description: Default request cost
  75   paid_price:
  76     type:
  77       - string
  78       - "null"
  79     description: Effective request cost
  80   opac_notes:
  81     type:
  82       - string
  83       - "null"
  84     description: Note that is visible to the patron
  85   staff_notes:
  86     type:
  87       - string
  88       - "null"
  89     description: Interal staff note about the request
  90   ill_backend_id:
  91     type: string
  92     description: The ILL backend identifier string
  93   ill_backend_request_id:
  94     type:
  95       - string
  96       - "null"
  97     description: Backend-specific request id
  98   status_av:
  99     type:
 100       - string
 101       - "null"
 102     description: The authorised value category the field is linked to
 103   biblio:
 104     type:
 105       - object
 106       - "null"
 107     description: The linked biblio object (x-koha-embed)
 108   comments:
 109     type:
 110       - array
 111       - "null"
 112     description: The linked comment objects (x-koha-embed)
 113   comments_count:
 114     type:
 115       - integer
 116       - "null"
 117     description: The linked comment objects count (x-koha-embed)
 118   extended_attributes:
 119     type:
 120       - array
 121       - "null"
 122     description: The linked extended ill request attributes (x-koha-embed)
 123   ill_batch:
 124     type:
 125       - object
 126       - "null"
 127     description: The linked ill batch object (x-koha-embed)
 128   library:
 129     type:
 130       - object
 131       - "null"
 132     description: The linked library object (x-koha-embed)
 133   id_prefix:
 134     type:
 135       - string
 136       - "null"
 137     description: The id_prefix of the request (x-koha-embed)
 138   patron:
 139     type:
 140       - object
 141       - "null"
 142     description: The linked patron object (x-koha-embed)
 143   _strings:
 144     type:
 145       - object
 146       - "null"
 147     description: Expanded coded fiels (x-koha-embed)
 148
 149 additionalProperties: false