Open-ILS/src/extras/ils_events.xml

   1 <ils_events>
   2         <notes>
   3                 This file describes the event codes that an ILS method might return.  Not all
   4                 methods will return event codes and it is up to each method to define which
   5                 types of events it may return.  The standard event procedure is to return an
   6                 object (JSON hash) with a field called "ilsevent" which contains the event code
   7                 below.
   8
   9                 If events need to be placed into groups for any reason, the segregation shall
  10                 be defined below with the accompanying events.
  11         </notes>
  12
  13         <event code='0' textcode='SUCCESS'>
  14                 <desc>No errors or unexpected events occurred</desc>
  15         </event>
  16
  17         <event code='1' textcode='UNKNOWN'>
  18                 <desc>Placeholder event.  Used for development only</desc>
  19         </event>
  20
  21
  22         <event code='1000' textcode='LOGIN_FAILED'>
  23                 <desc>
  24                         User login failed.  Why the login failed is not specified.
  25                 </desc>
  26         </event>
  27
  28         <event code='1001' textcode='NO_SESSION'>
  29                 <desc>
  30                         User login session has either timed out or does not exist.
  31                 </desc>
  32         </event>
  33
  34         <event code='1002' textcode='USER_NOT_FOUND'>
  35                 <desc>
  36                         Someone attempted to retrieve a user from the system and the user
  37                         was not found.
  38                 </desc>
  39         </event>
  40
  41         <event code='1200' textcode='USERNAME_EXISTS'>
  42                 <desc>
  43                         The given username exists in the database
  44                 </desc>
  45         </event>
  46
  47         <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
  48                 <desc>
  49                         A checkout was attempted without a valid checkout permit key
  50                 </desc>
  51         </event>
  52
  53         <event code='1202' textcode='ITEM_NOT_CATALOGED'>
  54                 <desc>
  55                         The requested item is not cataloged in the database
  56                 </desc>
  57         </event>
  58
  59
  60
  61
  62         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
  63                 <desc>
  64                         Someone attempted to retrieve a circulation object from the system and
  65                         the object was not found.
  66                 </desc>
  67         </event>
  68
  69         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
  70                 <desc>
  71                         Someone attempted to retrieve a biblio record entry object from the
  72                         system and the object was not found.
  73                 </desc>
  74         </event>
  75
  76         <event code='1502' textcode='COPY_NOT_FOUND'>
  77                 <desc>
  78                         Someone attempted to retrieve a copy object from the
  79                         system and the object was not found.
  80                 </desc>
  81         </event>
  82
  83         <event code='1503' textcode='HOLD_NOT_FOUND'>
  84                 <desc>
  85                         Someone attempted to retrieve a hold object from the
  86                         system and the object was not found.
  87                 </desc>
  88         </event>
  89
  90         <event code='1504' textcode='TRANSIT_NOT_FOUND'>
  91                 <desc>
  92                         Someone attempted to retrieve a transit object from the
  93                         system and the object was not found.
  94                 </desc>
  95         </event>
  96
  97         <event code='1505' textcode='BILLING_NOT_FOUND'>
  98                 <desc>
  99                         Someone attempted to retrieve a transit object from the
 100                         system and the object was not found.
 101                 </desc>
 102         </event>
 103
 104         <event code='1506' textcode='CONTAINER_NOT_FOUND'>
 105                 <desc>
 106                         Someone attempted to retrieve a container object from the
 107                         system and the object was not found.
 108                 </desc>
 109         </event>
 110
 111         <event code='1507' textcode='CONTAINER_ITEM_NOT_FOUND'>
 112                 <desc>
 113                         Someone attempted to retrieve a container item object from the
 114                         system and the object was not found.
 115                 </desc>
 116         </event>
 117
 118         <event code='1508' textcode='VOLUME_NOT_FOUND'>
 119                 <desc>
 120                         Someone attempted to retrieve a volume object from the
 121                         system and the object was not found.
 122                 </desc>
 123         </event>
 124
 125         <event code='1509' textcode='ORG_UNIT_NOT_FOUND'>
 126                 <desc>
 127                         Someone attempted to retrieve an org unit object from the
 128                         system and the object was not found.
 129                 </desc>
 130         </event>
 131
 132         <event code='1510' textcode='STAT_CAT_NOT_FOUND'>
 133                 <desc> Stat cat object does not exist </desc>
 134         </event>
 135
 136         <event code='1511' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
 137                 <desc> Stat cat entry object does not exist </desc>
 138         </event>
 139
 140         <event code='1512' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
 141                 <desc> Stat cat entry map object does not exist </desc>
 142         </event>
 143
 144         <event code='1513' textcode='NON_CAT_TYPE_NOT_FOUND'>
 145                 <desc> The non cataloged type object does not exist </desc>
 146         </event>
 147
 148         <event code='1514' textcode='CIRC_DURATION_NOT_FOUND'>
 149                 <desc> The circ duration object does not exist </desc>
 150         </event>
 151
 152         <event code='1515' textcode='RECURRING_FINE_NOT_FOUND'>
 153                 <desc> The recurring fines object does not exist </desc>
 154         </event>
 155
 156         <event code='1516' textcode='MAX_FINE_NOT_FOUND'>
 157                 <desc> The max fines object does not exist </desc>
 158         </event>
 159
 160         <event code='1517' textcode='COPY_LOCATION_NOT_FOUND'>
 161                 <desc> The copy location object does not exist </desc>
 162         </event>
 163
 164         <event code='1518' textcode='HOLD_TRANSIT_NOT_FOUND'>
 165                 <desc> The hold transit object does not exist </desc>
 166         </event>
 167
 168
 169
 170
 171         <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
 172                 <desc> The non-cataloged type object already exists </desc>
 173         </event>
 174
 175         <event code='1701' textcode='COPY_LOCATION_EXISTS'>
 176                 <desc> The copy location object already exists </desc>
 177         </event>
 178
 179         <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
 180                 <desc> There is an open circulation on the requested item </desc>
 181         </event>
 182
 183
 184         <event code='2000' textcode='BAD_PARAMS'>
 185                 <desc>
 186                         Invalid parameters were encountered in a method
 187                 </desc>
 188         </event>
 189
 190         <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
 191                 <desc>
 192                         The attempt to write to the DB failed
 193                 </desc>
 194         </event>
 195
 196
 197         <event code='5000' textcode='PERM_FAILURE'>
 198                 <desc>
 199                         Permission Error.  * The object returning this code shall also
 200                         contain a field "ilsperm" containing the name of the permission which failed
 201                         and a field called "ilspermloc" defining the location at which the permission
 202                         failed if available.
 203                 </desc>
 204         </event>
 205
 206
 207         <!-- ================================================================ -->
 208         <!-- CIRC EVENTS -->
 209         <event code='7000' textcode='ROUTE_ITEM'>
 210                 <desc>
 211                         A copy needs to be routed to a different location
 212                         The destination location will be specified by an 'org' key
 213                         within the event object
 214                 </desc>
 215         </event>
 216
 217         <event code='7001' textcode='PATRON_BAD_STANDING'>
 218                 <desc>
 219                         The patron in question is not able to check out materials because
 220                         their account is in bad standing
 221                 </desc>
 222         </event>
 223
 224         <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
 225                 <desc>
 226                         The patron in question has the maximum number of items already checked out
 227                 </desc>
 228         </event>
 229
 230         <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
 231                 <desc> Target copy is not allowed to circulate </desc>
 232         </event>
 233
 234         <event code='7004' textcode='COPY_NOT_AVAILABLE'>
 235                 <desc> Copy is not available </desc>
 236         </event>
 237
 238         <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
 239                 <desc> Location does not allow materials to circulate </desc>
 240         </event>
 241
 242         <event code='7006' textcode='COPY_IS_REFERENCE'>
 243                 <desc> Copy is reference material </desc>
 244         </event>
 245
 246         <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
 247                 <desc> Copy is needed to fulfil a hold </desc>
 248         </event>
 249
 250         <event code='7008' textcode='MAX_RENEWALS_REACHED'>
 251                 <desc> Circulation has no more renewals remaining </desc>
 252         </event>
 253
 254         <event code='7009' textcode='ROUTE_TO_COPY_LOCATION'>
 255                 <desc>
 256                 A copy needs to be routed to a copy location.  The location
 257                 should be specified within the event with a 'location' key
 258                 </desc>
 259         </event>
 260
 261         <!-- ================================================================ -->
 262
 263 </ils_events>
 264
 265
 266
 267