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