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='1503' 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='1503' 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='1504' 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='1505' 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='1506' 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='1507' 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='1508' textcode='STAT_CAT_NOT_FOUND'>
 133                 <desc> Stat cat object does not exist </desc>
 134         </event>
 135
 136         <event code='1509' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
 137                 <desc> Stat cat entry object does not exist </desc>
 138         </event>
 139
 140         <event code='1510' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
 141                 <desc> Stat cat entry map object does not exist </desc>
 142         </event>
 143
 144         <event code='1511' textcode='NON_CAT_TYPE_NOT_FOUND'>
 145                 <desc> The non cataloged type object does not exist </desc>
 146         </event>
 147
 148         <event code='1512' textcode='CIRC_DURATION_NOT_FOUND'>
 149                 <desc> The circ duration object does not exist </desc>
 150         </event>
 151
 152         <event code='1513' textcode='RECURRING_FINE_NOT_FOUND'>
 153                 <desc> The recurring fines object does not exist </desc>
 154         </event>
 155
 156         <event code='1514' textcode='MAX_FINE_NOT_FOUND'>
 157                 <desc> The max fines object does not exist </desc>
 158         </event>
 159
 160         <event code='1515' textcode='COPY_LOCATION_NOT_FOUND'>
 161                 <desc> The copy location object does not exist </desc>
 162         </event>
 163
 164
 165
 166         <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
 167                 <desc> The non-cataloged type object already exists </desc>
 168         </event>
 169
 170         <event code='1701' textcode='COPY_LOCATION_EXISTS'>
 171                 <desc> The copy location object already exists </desc>
 172         </event>
 173
 174         <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
 175                 <desc> There is an open circulation on the requested item </desc>
 176         </event>
 177
 178
 179         <event code='2000' textcode='BAD_PARAMS'>
 180                 <desc>
 181                         Invalid parameters were encountered in a method
 182                 </desc>
 183         </event>
 184
 185         <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
 186                 <desc>
 187                         The attempt to write to the DB failed
 188                 </desc>
 189         </event>
 190
 191
 192         <event code='5000' textcode='PERM_FAILURE'>
 193                 <desc>
 194                         Permission Error.  * The object returning this code shall also
 195                         contain a field "ilsperm" containing the name of the permission which failed
 196                         and a field called "ilspermloc" defining the location at which the permission
 197                         failed if available.
 198                 </desc>
 199         </event>
 200
 201
 202         <!-- ================================================================ -->
 203         <!-- CIRC EVENTS -->
 204         <event code='7000' textcode='ROUTE_COPY'>
 205                 <desc> A copy needs to be routed to a different location        </desc>
 206         </event>
 207
 208         <event code='7001' textcode='PATRON_BAD_STANDING'>
 209                 <desc>
 210                         The patron in question is not able to check out materials because
 211                         their account is in bad standing
 212                 </desc>
 213         </event>
 214
 215         <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
 216                 <desc>
 217                         The patron in question has the maximum number of items already checked out
 218                 </desc>
 219         </event>
 220
 221         <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
 222                 <desc> Target copy is not allowed to circulate </desc>
 223         </event>
 224
 225         <event code='7004' textcode='COPY_NOT_AVAILABLE'>
 226                 <desc> Copy is not available </desc>
 227         </event>
 228
 229         <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
 230                 <desc> Location does not allow materials to circulate </desc>
 231         </event>
 232
 233         <event code='7006' textcode='COPY_IS_REFERENCE'>
 234                 <desc> Copy is reference material </desc>
 235         </event>
 236
 237         <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
 238                 <desc> Copy is needed to fulfil a hold </desc>
 239         </event>
 240
 241         <event code='7008' textcode='MAX_RENEWALS_REACHED'>
 242                 <desc> Circulation has no more renewals remaining </desc>
 243         </event>
 244         <!-- ================================================================ -->
 245
 246 </ils_events>
 247
 248
 249
 250