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         <event code='1205' textcode='CARD_EXISTS'>
  70                 <desc>
  71                         The given user barcode already exists
  72                 </desc>
  73         </event>
  74
  75
  76
  77
  78
  79         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
  80                 <desc>
  81                         Someone attempted to retrieve a circulation object from the system and
  82                         the object was not found.
  83                 </desc>
  84         </event>
  85         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
  86                 <desc>
  87                         Someone attempted to retrieve a biblio record entry object from the
  88                         system and the object was not found.
  89                 </desc>
  90         </event>
  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         <event code='1503' textcode='HOLD_NOT_FOUND'>
  98                 <desc>
  99                         Someone attempted to retrieve a hold object from the
 100                         system and the object was not found.
 101                 </desc>
 102         </event>
 103         <event code='1504' textcode='TRANSIT_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='1505' textcode='BILLING_NOT_FOUND'>
 110                 <desc>
 111                         Someone attempted to retrieve a transit object from the
 112                         system and the object was not found.
 113                 </desc>
 114         </event>
 115         <event code='1506' textcode='CONTAINER_NOT_FOUND'>
 116                 <desc>
 117                         Someone attempted to retrieve a container object from the
 118                         system and the object was not found.
 119                 </desc>
 120         </event>
 121         <event code='1507' textcode='CONTAINER_ITEM_NOT_FOUND'>
 122                 <desc>
 123                         Someone attempted to retrieve a container item object from the
 124                         system and the object was not found.
 125                 </desc>
 126         </event>
 127         <event code='1508' textcode='VOLUME_NOT_FOUND'>
 128                 <desc>
 129                         Someone attempted to retrieve a volume object from the
 130                         system and the object was not found.
 131                 </desc>
 132         </event>
 133         <event code='1509' textcode='ORG_UNIT_NOT_FOUND'>
 134                 <desc>
 135                         Someone attempted to retrieve an org unit object from the
 136                         system and the object was not found.
 137                 </desc>
 138         </event>
 139         <event code='1510' textcode='STAT_CAT_NOT_FOUND'>
 140                 <desc> Stat cat object does not exist </desc>
 141         </event>
 142         <event code='1511' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
 143                 <desc> Stat cat entry object does not exist </desc>
 144         </event>
 145         <event code='1512' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
 146                 <desc> Stat cat entry map object does not exist </desc>
 147         </event>
 148         <event code='1513' textcode='NON_CAT_TYPE_NOT_FOUND'>
 149                 <desc> The non cataloged type object does not exist </desc>
 150         </event>
 151         <event code='1514' textcode='CIRC_DURATION_NOT_FOUND'>
 152                 <desc> The circ duration object does not exist </desc>
 153         </event>
 154         <event code='1515' textcode='RECURRING_FINE_NOT_FOUND'>
 155                 <desc> The recurring fines object does not exist </desc>
 156         </event>
 157         <event code='1516' textcode='MAX_FINE_NOT_FOUND'>
 158                 <desc> The max fines object does not exist </desc>
 159         </event>
 160         <event code='1517' textcode='COPY_LOCATION_NOT_FOUND'>
 161                 <desc> The copy location object does not exist </desc>
 162         </event>
 163         <event code='1518' textcode='HOLD_TRANSIT_NOT_FOUND'>
 164                 <desc> The hold transit object does not exist </desc>
 165         </event>
 166         <event code='1519' textcode='TRANSACTION_NOT_FOUND'>
 167                 <desc> Requested transaction object does not exist </desc>
 168         </event>
 169         <event code='1520' textcode='WORKSTATION_NOT_FOUND'>
 170                 <desc> Requested workstation object does not exist </desc>
 171         </event>
 172         <event code='1521' textcode='COPY_NOTE_NOT_FOUND'>
 173                 <desc> Requested copy note does not exist </desc>
 174         </event>
 175         <event code='1522' textcode='VOLUME_NOTE_NOT_FOUND'>
 176                 <desc> Requested copy note does not exist </desc>
 177         </event>
 178         <event code='1523' textcode='TITLE_NOTE_NOT_FOUND'>
 179                 <desc> Requested copy note does not exist </desc>
 180         </event>
 181         <event code='1524' textcode='CARD_NOT_FOUND'>
 182                 <desc> Requested copy note does not exist </desc>
 183         </event>
 184         <event code='1525' textcode='BILLING_NOT_FOUND'>
 185                 <desc> Requested copy note does not exist </desc>
 186         </event>
 187         <event code='1526' textcode='BILLABLE_XACT_SUMMARY_NOT_FOUND'>
 188                 <desc> Requested transaction summary does not exist </desc>
 189         </event>
 190
 191         <event code='1527' textcode='OPEN_TCN_NOT_FOUND'>
 192                 <desc>No TCN could be found that does not collide with existing records</desc>
 193         </event>
 194
 195
 196
 197
 198         <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
 199                 <desc> The non-cataloged type object already exists </desc>
 200         </event>
 201
 202         <event code='1701' textcode='COPY_LOCATION_EXISTS'>
 203                 <desc> The copy location object already exists </desc>
 204         </event>
 205
 206         <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
 207                 <desc> There is an open circulation on the requested item </desc>
 208         </event>
 209
 210         <event code='1703' textcode='WORKSTATION_NAME_EXISTS'>
 211                 <desc> A workstation with that name already exists </desc>
 212         </event>
 213
 214         <event code='1704' textcode='TCN_EXISTS'>
 215                 <desc>A record already exists with the requested TCN value</desc>
 216         </event>
 217
 218
 219
 220         <event code='2000' textcode='BAD_PARAMS'>
 221                 <desc>
 222                         Invalid parameters were encountered in a method
 223                 </desc>
 224         </event>
 225
 226         <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
 227                 <desc>
 228                         The attempt to write to the DB failed
 229                 </desc>
 230         </event>
 231
 232
 233         <event code='5000' textcode='PERM_FAILURE'>
 234                 <desc>
 235                         Permission Error.  * The object returning this code shall also
 236                         contain a field "ilsperm" containing the name of the permission which failed
 237                         and a field called "ilspermloc" defining the location at which the permission
 238                         failed if available.
 239                 </desc>
 240         </event>
 241
 242
 243         <!-- ================================================================ -->
 244         <!-- CIRC EVENTS -->
 245         <event code='7000' textcode='ROUTE_ITEM'>
 246                 <desc>
 247                         A copy needs to be routed to a different location
 248                         The destination location will be specified by an 'org' key
 249                         within the event object
 250                 </desc>
 251         </event>
 252
 253         <event code='7001' textcode='PATRON_BAD_STANDING'>
 254                 <desc>
 255                         The patron in question is not able to check out materials because
 256                         their account is in bad standing
 257                 </desc>
 258         </event>
 259
 260         <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
 261                 <desc>
 262                         The patron in question has the maximum number of items already checked out
 263                 </desc>
 264         </event>
 265
 266         <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
 267                 <desc> Target copy is not allowed to circulate </desc>
 268         </event>
 269
 270         <event code='7004' textcode='COPY_NOT_AVAILABLE'>
 271                 <desc> Copy is not available </desc>
 272         </event>
 273
 274         <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
 275                 <desc> Location does not allow materials to circulate </desc>
 276         </event>
 277
 278         <event code='7006' textcode='COPY_IS_REFERENCE'>
 279                 <desc> Copy is reference material </desc>
 280         </event>
 281
 282         <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
 283                 <desc> Copy is needed to fulfil a hold </desc>
 284         </event>
 285
 286         <event code='7008' textcode='MAX_RENEWALS_REACHED'>
 287                 <desc> Circulation has no more renewals remaining </desc>
 288         </event>
 289
 290         <event code='7009' textcode='ROUTE_TO_COPY_LOCATION'>
 291                 <desc>
 292                 A copy needs to be routed to a copy location.  The location
 293                 should be specified within the event with a 'location' key
 294                 </desc>
 295         </event>
 296
 297         <event code='7009' textcode='CIRC_CLAIMS_RETURNED'>
 298                 <desc> Requested circulation is marked claims returned </desc>
 299         </event>
 300
 301         <event code='7010' textcode='COPY_ALERT_MESSAGE'>
 302                 <desc> The requested copy has an alert message attached </desc>
 303         </event>
 304
 305         <event code='7011' textcode='COPY_STATUS_LOST'>
 306                 <desc>Copy has is marked as lost</desc>
 307         </event>
 308
 309         <event code='7012' textcode='COPY_STATUS_MISSING'>
 310                 <desc>Copy has is marked as missing</desc>
 311         </event>
 312
 313         <event code='7013' textcode='PATRON_EXCEEDS_FINES'>
 314                 <desc>The patron in question has reached the maximum fine amount</desc>
 315         </event>
 316
 317         <!-- ================================================================ -->
 318
 319
 320         <event code='8000' textcode='OFFLINE_SESSION_ACTIVE'>
 321                 <desc> An offline session for this location is currently processing </desc>
 322         </event>
 323         <event code='8001' textcode='OFFLINE_SESSION_FILE_EXISTS'>
 324                 <desc> An offline file for this workstation exists within this session </desc>
 325         </event>
 326         <event code='8002' textcode='OFFLINE_FILE_ERROR'>
 327                 <desc> An offline file or directory could not be created or accessed </desc>
 328         </event>
 329         <event code='8003' textcode='OFFLINE_PARAM_ERROR'>
 330                 <desc> Missing params in offline upload </desc>
 331         </event>
 332         <event code='8004' textcode='OFFLINE_CONFIG_ERROR'>
 333                 <desc> Offline server is not configured properly </desc>
 334         </event>
 335         <event code='8005' textcode='OFFLINE_CHECKSUM_FAILED'>
 336                 <desc> Offline server is not configured properly </desc>
 337         </event>
 338         <event code='8006' textcode='OFFLINE_SESSION_NOT_FOUND'>
 339                 <desc> Offline server is not configured properly </desc>
 340         </event>
 341         <event code='8007' textcode='OFFLINE_SESSION_EXISTS'>
 342                 <desc> A session with the given name already exists </desc>
 343         </event>
 344         <event code='8008' textcode='OFFLINE_INVALID_SESSION'>
 345                 <desc> The session name is invalid </desc>
 346         </event>
 347         <event code='8009' textcode='OFFLINE_NO_ORG'>
 348                 <desc> No org id was provided </desc>
 349         </event>
 350         <event code='8010' textcode='OFFLINE_SESSION_COMPLETE'>
 351                 <desc> No org id was provided </desc>
 352         </event>
 353
 354         <!-- ================================================================ -->
 355
 356 </ils_events>
 357
 358
 359
 360