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