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