api/v1/swagger/definitions/suggestion.yaml

   1 ---
   2 type: object
   3 properties:
   4   suggestion_id:
   5     type: integer
   6     readOnly: true
   7     description: unique identifier assigned automatically by Koha
   8   suggested_by:
   9     type:
  10       - integer
  11       - "null"
  12     description: patron_id for the person making the suggestion, foreign key linking to the
  13       borrowers table
  14   suggestion_date:
  15     type: string
  16     format: date
  17     description: the suggestion was submitted
  18   managed_by:
  19     type:
  20       - integer
  21       - "null"
  22     description: patron_id for the librarian managing the suggestion, foreign key linking
  23       to the borrowers table
  24   managed_date:
  25     type:
  26       - string
  27       - "null"
  28     format: date
  29     description: date the suggestion was updated
  30   accepted_by:
  31     type:
  32       - integer
  33       - "null"
  34     description: patron_id for the librarian who accepted the suggestion, foreign key
  35       linking to the borrowers table
  36   accepted_date:
  37     type:
  38       - string
  39       - "null"
  40     format: date
  41     description: date the suggestion was marked as accepted
  42   rejected_by:
  43     type:
  44       - integer
  45       - "null"
  46     description: patron_id for the librarian who rejected the suggestion, foreign key
  47       linking to the borrowers table
  48   rejected_date:
  49     type:
  50       - string
  51       - "null"
  52     format: date
  53     description: date the suggestion was marked as rejected
  54   last_status_change_by:
  55     type:
  56       - integer
  57       - "null"
  58     description: patron the suggestion was last modified by
  59   last_status_change_date:
  60     type:
  61       - string
  62       - "null"
  63     format: date
  64     description: date the suggestion was last modified
  65   status:
  66     type: string
  67     description: Suggestion status
  68     enum:
  69       - ASKED
  70       - CHECKED
  71       - ACCEPTED
  72       - REJECTED
  73   note:
  74     type:
  75       - string
  76       - "null"
  77     description: note entered on the suggestion
  78   author:
  79     type:
  80       - string
  81       - "null"
  82     description: author of the suggested item
  83   title:
  84     type:
  85       - string
  86       - "null"
  87     description: title of the suggested item
  88   copyright_date:
  89     type:
  90       - integer
  91       - "null"
  92     description: copyright date of the suggested item
  93   publisher_code:
  94     type:
  95       - string
  96       - "null"
  97     description: publisher of the suggested item
  98   timestamp:
  99     type:
 100       - string
 101       - "null"
 102     format: date-time
 103     description: timestamp of date created
 104   volume_desc:
 105     type:
 106       - string
 107       - "null"
 108     description: volume description
 109   publication_year:
 110     type:
 111       - string
 112       - "null"
 113     description: year of publication
 114   publication_place:
 115     type:
 116       - string
 117       - "null"
 118     description: publication place of the suggested item
 119   isbn:
 120     type:
 121       - string
 122       - "null"
 123     description: isbn of the suggested item
 124   biblio_id:
 125     type:
 126       - integer
 127       - "null"
 128     description: foreign key linking the suggestion to the biblio table after the
 129       suggestion has been ordered
 130   reason:
 131     type:
 132       - string
 133       - "null"
 134     description: reason for accepting or rejecting the suggestion
 135   patron_reason:
 136     type:
 137       - string
 138       - "null"
 139     description: reason for making the suggestion
 140   budget_id:
 141     type:
 142       - integer
 143       - "null"
 144     description: foreign key linking the suggested budget to the aqbudgets table
 145   library_id:
 146     type:
 147       - string
 148       - "null"
 149     description: foreign key linking the suggested branch to the branches table
 150   collection_title:
 151     type:
 152       - string
 153       - "null"
 154     description: collection name for the suggested item
 155   item_type:
 156     type:
 157       - string
 158       - "null"
 159     description: suggested item type
 160   quantity:
 161     type:
 162       - string
 163       - "null"
 164     description: suggested quantity to be purchased
 165   currency:
 166     type:
 167       - string
 168       - "null"
 169     description: suggested currency for the suggested price
 170   item_price:
 171     type:
 172       - number
 173       - "null"
 174     description: suggested price
 175   total_price:
 176     type:
 177       - string
 178       - "null"
 179     description: suggested total cost (price*quantity updated for currency)
 180   archived:
 181     type:
 182       - boolean
 183       - "null"
 184     description: archived (processed) suggestion
 185 additionalProperties: false