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