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