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