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 xml:lang="en-US"> </desc>
  15         </event>
  16         <event code='1' textcode='UNKNOWN'>
  17                 <desc xml:lang="en-US">Placeholder event.  Used for development only</desc>
  18         </event>
  19         <event code='3' textcode='NO_CHANGE'>
  20                 <desc xml:lang="en-US">No change occurred</desc>
  21         </event>
  22         <event code='1000' textcode='LOGIN_FAILED'>
  23                 <desc xml:lang="en-US">User login failed</desc>
  24         </event>
  25         <event code='1001' textcode='NO_SESSION'>
  26                 <desc xml:lang="en-US">User login session has either timed out or does not exist</desc>
  27         </event>
  28         <event code='1002' textcode='ACTOR_USER_NOT_FOUND'>
  29                 <desc xml:lang="en-US">Someone attempted to retrieve a user from the system and the user was not found</desc>
  30         </event>
  31         <event code='1003' textcode='Z3950_SEARCH_FAILED'>
  32                 <desc xml:lang="en-US">The Z search did not succeed</desc>
  33         </event>
  34         <event code='1200' textcode='USERNAME_EXISTS'>
  35                 <desc xml:lang="en-US">The given username already exists in the database</desc>
  36         </event>
  37         <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
  38                 <desc xml:lang="en-US">A checkout was attempted without a valid checkout permit key</desc>
  39         </event>
  40         <event code='1202' textcode='ITEM_NOT_CATALOGED'>
  41                 <desc xml:lang="en-US">The requested item is not cataloged in the database</desc>
  42         </event>
  43         <event code='1203' textcode='COPY_BAD_STATUS'>
  44                 <desc xml:lang="en-US">The given copy is not in a standard circulation status</desc>
  45         </event>
  46         <event code='1204' textcode='CIRC_BAD_STATUS'>
  47                 <desc xml:lang="en-US">
  48                         The given circulation is not in a standard status or
  49                         the circulation was never fully closed properly
  50                 </desc>
  51         </event>
  52         <event code='1205' textcode='CARD_EXISTS'>
  53                 <desc xml:lang="en-US">The given user barcode already exists</desc>
  54         </event>
  55         <event code='1206' textcode='VOLUME_NOT_EMPTY'>
  56                 <desc xml:lang="en-US">The selected volume has copies attached</desc>
  57         </event>
  58         <event code='1207' textcode='REFUND_EXCEEDS_BALANCE'>
  59                 <desc xml:lang="en-US">A refund greater than the negative balance on a transaction was provided</desc>
  60         </event>
  61         <event code='1208' textcode='TITLE_LAST_COPY'>
  62                 <desc xml:lang="en-US">The last copy attached to a title is being removed or deleted</desc>
  63         </event>
  64         <event code='1209' textcode='Z3950_LOGIN_FAILED'>
  65                 <desc xml:lang="en-US">The login failed</desc>
  66         </event>
  67         <event code='1210' textcode='INCORRECT_PASSWORD'>
  68                 <!-- used when updating a password and the original is wrong -->
  69                 <desc xml:lang="en-US">The provided password is not correct</desc>
  70         </event>
  71
  72
  73
  74
  75
  76         <event code='1500' textcode='ACTION_CIRCULATION_NOT_FOUND'>
  77                 <desc xml:lang="en-US">
  78                         Someone attempted to retrieve a circulation object from the system and
  79                         the object was not found.
  80                 </desc>
  81         </event>
  82         <event code='1501' textcode='BIBLIO_RECORD_ENTRY_NOT_FOUND'>
  83                 <desc xml:lang="en-US">
  84                         Someone attempted to retrieve a biblio record entry object from the
  85                         system and the object was not found.
  86                 </desc>
  87         </event>
  88         <event code='1502' textcode='ASSET_COPY_NOT_FOUND'>
  89                 <desc xml:lang="en-US">
  90                         Someone attempted to retrieve a copy object from the
  91                         system and the object was not found.
  92                 </desc>
  93         </event>
  94         <event code='1503' textcode='ACTION_HOLD_REQUEST_NOT_FOUND'>
  95                 <desc xml:lang="en-US">
  96                         Someone attempted to retrieve a hold object from the
  97                         system and the object was not found.
  98                 </desc>
  99         </event>
 100         <event code='1504' textcode='ACTION_TRANSIT_COPY_NOT_FOUND'>
 101                 <desc xml:lang="en-US">
 102                         Someone attempted to retrieve a transit object from the
 103                         system and the object was not found.
 104                 </desc>
 105         </event>
 106         <event code='1505' textcode='MONEY_BILLING_NOT_FOUND'>
 107                 <desc xml:lang="en-US">
 108                         Someone attempted to retrieve a transit object from the
 109                         system and the object was not found.
 110                 </desc>
 111         </event>
 112         <event code='1506' textcode='CONTAINER_NOT_FOUND'>
 113                 <desc xml:lang="en-US">
 114                         Someone attempted to retrieve a container object from the
 115                         system and the object was not found.
 116                 </desc>
 117         </event>
 118         <event code='1507' textcode='CONTAINER_ITEM_NOT_FOUND'>
 119                 <desc xml:lang="en-US">
 120                         Someone attempted to retrieve a container item object from the
 121                         system and the object was not found.
 122                 </desc>
 123         </event>
 124         <event code='1508' textcode='ASSET_CALL_NUMBER_NOT_FOUND'>
 125                 <desc xml:lang="en-US">
 126                         Someone attempted to retrieve a volume object from the
 127                         system and the object was not found.
 128                 </desc>
 129         </event>
 130         <event code='1509' textcode='ORG_UNIT_NOT_FOUND'>
 131                 <desc xml:lang="en-US">
 132                         Someone attempted to retrieve an org unit object from the
 133                         system and the object was not found.
 134                 </desc>
 135         </event>
 136         <event code='1510' textcode='STAT_CAT_NOT_FOUND'>
 137                 <desc xml:lang="en-US"> Stat cat object does not exist </desc>
 138         </event>
 139         <event code='1511' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
 140                 <desc xml:lang="en-US"> Stat cat entry object does not exist </desc>
 141         </event>
 142         <event code='1512' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
 143                 <desc xml:lang="en-US"> Stat cat entry map object does not exist </desc>
 144         </event>
 145         <event code='1513' textcode='NON_CAT_TYPE_NOT_FOUND'>
 146                 <desc xml:lang="en-US"> The non cataloged type object does not exist </desc>
 147         </event>
 148         <event code='1514' textcode='CIRC_DURATION_NOT_FOUND'>
 149                 <desc xml:lang="en-US"> The circ duration object does not exist </desc>
 150         </event>
 151         <event code='1515' textcode='RECURRING_FINE_NOT_FOUND'>
 152                 <desc xml:lang="en-US"> The recurring fines object does not exist </desc>
 153         </event>
 154         <event code='1516' textcode='MAX_FINE_NOT_FOUND'>
 155                 <desc xml:lang="en-US"> The max fines object does not exist </desc>
 156         </event>
 157         <event code='1517' textcode='COPY_LOCATION_NOT_FOUND'>
 158                 <desc xml:lang="en-US"> The copy location object does not exist </desc>
 159         </event>
 160         <event code='1518' textcode='HOLD_TRANSIT_NOT_FOUND'>
 161                 <desc xml:lang="en-US"> The hold transit object does not exist </desc>
 162         </event>
 163         <event code='1519' textcode='TRANSACTION_NOT_FOUND'>
 164                 <desc xml:lang="en-US"> Requested transaction object does not exist </desc>
 165         </event>
 166         <event code='1520' textcode='WORKSTATION_NOT_FOUND'>
 167                 <desc xml:lang="en-US"> Requested workstation object does not exist </desc>
 168         </event>
 169         <event code='1521' textcode='COPY_NOTE_NOT_FOUND'>
 170                 <desc xml:lang="en-US"> Requested copy note does not exist </desc>
 171         </event>
 172         <event code='1522' textcode='VOLUME_NOTE_NOT_FOUND'>
 173                 <desc xml:lang="en-US"> Requested volume note does not exist </desc>
 174         </event>
 175         <event code='1523' textcode='TITLE_NOTE_NOT_FOUND'>
 176                 <desc xml:lang="en-US"> Requested title note does not exist </desc>
 177         </event>
 178         <event code='1524' textcode='CARD_NOT_FOUND'>
 179                 <desc xml:lang="en-US"> Requested card note does not exist </desc>
 180         </event>
 181         <event code='1525' textcode='BILLING_NOT_FOUND'>
 182                 <desc xml:lang="en-US"> Requested billing note does not exist </desc>
 183         </event>
 184         <event code='1526' textcode='BILLABLE_XACT_SUMMARY_NOT_FOUND'>
 185                 <desc xml:lang="en-US"> Requested transaction summary does not exist </desc>
 186         </event>
 187         <event code='1527' textcode='OPEN_TCN_NOT_FOUND'>
 188                 <desc xml:lang="en-US">No TCN could be found that does not collide with existing records</desc>
 189         </event>
 190         <event code='1528' textcode='ACTOR_USER_ADDRESS_NOT_FOUND'>
 191                 <desc xml:lang="en-US">Requested address was not found</desc>
 192         </event>
 193         <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
 194                 <desc xml:lang="en-US"> The non-cataloged type object already exists </desc>
 195         </event>
 196         <event code='1701' textcode='COPY_LOCATION_EXISTS'>
 197                 <desc xml:lang="en-US"> The copy location object already exists </desc>
 198         </event>
 199         <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
 200                 <desc xml:lang="en-US"> There is an open circulation on the requested item </desc>
 201         </event>
 202         <event code='1703' textcode='WORKSTATION_NAME_EXISTS'>
 203                 <desc xml:lang="en-US"> A workstation with that name already exists </desc>
 204         </event>
 205         <event code='1704' textcode='TCN_EXISTS'>
 206                 <desc xml:lang="en-US">A record already exists with the requested TCN value</desc>
 207         </event>
 208         <event code='1705' textcode='VOLUME_LABEL_EXISTS'>
 209                 <desc xml:lang="en-US">A volume with the same label, title and owning library exists</desc>
 210         </event>
 211         <event code='1706' textcode='ITEM_BARCODE_EXISTS'>
 212                 <desc xml:lang="en-US">An item with the same barcode exists</desc>
 213         </event>
 214
 215
 216
 217         <event code='2000' textcode='BAD_PARAMS'>
 218                 <desc xml:lang="en-US">Invalid parameters were encountered in a method</desc>
 219         </event>
 220         <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
 221                 <desc xml:lang="en-US">The attempt to write to the DB failed</desc>
 222         </event>
 223         <event code='5000' textcode='PERM_FAILURE'>
 224                 <desc xml:lang="en-US">Permission Denied</desc>
 225         </event>
 226
 227         <!-- ================================================================ -->
 228         <!-- CIRC EVENTS -->
 229         <event code='7000' textcode='ROUTE_ITEM'>
 230                 <desc xml:lang="en-US">
 231                         A copy needs to be routed to a different location
 232                         The destination location will be specified by an 'org' key
 233                         within the event object
 234                 </desc>
 235         </event>
 236
 237         <event code='7001' textcode='PATRON_BAD_STANDING'>
 238                 <desc xml:lang="en-US">
 239                         The patron in question is not able to check out materials because
 240                         their account is in bad standing
 241                 </desc>
 242         </event>
 243
 244         <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
 245                 <desc xml:lang="en-US">The patron in question has the maximum number of items already checked out</desc>
 246         </event>
 247         <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
 248                 <desc xml:lang="en-US"> Target copy is not allowed to circulate </desc>
 249         </event>
 250         <event code='7004' textcode='COPY_NOT_AVAILABLE'>
 251                 <desc xml:lang="en-US"> Copy is not available </desc>
 252         </event>
 253         <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
 254                 <desc xml:lang="en-US"> Location does not allow materials to circulate </desc>
 255         </event>
 256         <event code='7006' textcode='COPY_IS_REFERENCE'>
 257                 <desc xml:lang="en-US"> Copy is reference material </desc>
 258         </event>
 259         <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
 260                 <desc xml:lang="en-US"> Copy is needed to fulfil a hold </desc>
 261         </event>
 262         <event code='7008' textcode='MAX_RENEWALS_REACHED'>
 263                 <desc xml:lang="en-US"> Circulation has no more renewals remaining </desc>
 264         </event>
 265         <event code='7009' textcode='ROUTE_TO_COPY_LOCATION'>
 266                 <desc xml:lang="en-US">
 267                 A copy needs to be routed to a copy location.  The location
 268                 should be specified within the event with a 'location' key
 269                 </desc>
 270         </event>
 271         <event code='7009' textcode='CIRC_CLAIMS_RETURNED'>
 272                 <desc xml:lang="en-US"> Requested circulation is marked claims returned </desc>
 273         </event>
 274         <event code='7010' textcode='COPY_ALERT_MESSAGE'>
 275                 <desc xml:lang="en-US"> The requested copy has an alert message attached </desc>
 276         </event>
 277         <event code='7011' textcode='COPY_STATUS_LOST'>
 278                 <desc xml:lang="en-US">Copy has is marked as lost</desc>
 279         </event>
 280         <event code='7012' textcode='COPY_STATUS_MISSING'>
 281                 <desc xml:lang="en-US">Copy has is marked as missing</desc>
 282         </event>
 283         <event code='7013' textcode='PATRON_EXCEEDS_FINES'>
 284                 <desc xml:lang="en-US">The patron in question has reached the maximum fine amount</desc>
 285         </event>
 286         <event code='7014' textcode='COPY_IN_TRANSIT'>
 287                 <desc xml:lang="en-US">Copy is in transit</desc>
 288         </event>
 289
 290         <!-- ================================================================ -->
 291
 292
 293         <event code='8000' textcode='OFFLINE_SESSION_ACTIVE'>
 294                 <desc xml:lang="en-US"> An offline session for this location is currently processing </desc>
 295         </event>
 296         <event code='8001' textcode='OFFLINE_SESSION_FILE_EXISTS'>
 297                 <desc xml:lang="en-US"> An offline file for this workstation exists within this session </desc>
 298         </event>
 299         <event code='8002' textcode='OFFLINE_FILE_ERROR'>
 300                 <desc xml:lang="en-US"> An offline file or directory could not be created or accessed </desc>
 301         </event>
 302         <event code='8003' textcode='OFFLINE_PARAM_ERROR'>
 303                 <desc xml:lang="en-US"> Missing params in offline upload </desc>
 304         </event>
 305         <event code='8004' textcode='OFFLINE_CONFIG_ERROR'>
 306                 <desc xml:lang="en-US"> Offline server is not configured properly </desc>
 307         </event>
 308         <event code='8005' textcode='OFFLINE_CHECKSUM_FAILED'>
 309                 <desc xml:lang="en-US"> Offline server is not configured properly </desc>
 310         </event>
 311         <event code='8006' textcode='OFFLINE_SESSION_NOT_FOUND'>
 312                 <desc xml:lang="en-US"> Offline server is not configured properly </desc>
 313         </event>
 314         <event code='8007' textcode='OFFLINE_SESSION_EXISTS'>
 315                 <desc xml:lang="en-US"> A session with the given name already exists </desc>
 316         </event>
 317         <event code='8008' textcode='OFFLINE_INVALID_SESSION'>
 318                 <desc xml:lang="en-US"> The session name is invalid </desc>
 319         </event>
 320         <event code='8009' textcode='OFFLINE_NO_ORG'>
 321                 <desc xml:lang="en-US"> No org id was provided </desc>
 322         </event>
 323         <event code='8010' textcode='OFFLINE_SESSION_COMPLETE'>
 324                 <desc xml:lang="en-US"> No org id was provided </desc>
 325         </event>
 326
 327         <!-- ================================================================ -->
 328
 329 </ils_events>
 330
 331
 332
 333