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