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