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
  17         <event code='1000' textcode='LOGIN_FAILED'>
  18                 <desc>
  19                         User login failed.  Why the login failed is not specified.
  20                 </desc>
  21         </event>
  22
  23         <event code='1001' textcode='NO_SESSION'>
  24                 <desc>
  25                         User login session has either timed out or does not exist.
  26                 </desc>
  27         </event>
  28
  29         <event code='1002' textcode='USER_NOT_FOUND'>
  30                 <desc>
  31                         Someone attempted to retrieve a user from the system and the user
  32                         was not found.
  33                 </desc>
  34         </event>
  35
  36         <event code='1200' textcode='USERNAME_EXISTS'>
  37                 <desc>
  38                         The given username exists in the database
  39                 </desc>
  40         </event>
  41
  42         <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
  43                 <desc>
  44                         A checkout was attempted without a valid checkout permit key
  45                 </desc>
  46         </event>
  47
  48         <event code='1202' textcode='ITEM_NOT_CATALOGED'>
  49                 <desc>
  50                         The requested item is not cataloged in the database
  51                 </desc>
  52         </event>
  53
  54
  55
  56
  57         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
  58                 <desc>
  59                         Someone attempted to retrieve a circulation object from the system and
  60                         the object was not found.
  61                 </desc>
  62         </event>
  63
  64         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
  65                 <desc>
  66                         Someone attempted to retrieve a biblio record entry object from the
  67                         system and the object was not found.
  68                 </desc>
  69         </event>
  70
  71         <event code='1502' textcode='COPY_NOT_FOUND'>
  72                 <desc>
  73                         Someone attempted to retrieve a copy object from the
  74                         system and the object was not found.
  75                 </desc>
  76         </event>
  77
  78         <event code='1503' textcode='HOLD_NOT_FOUND'>
  79                 <desc>
  80                         Someone attempted to retrieve a hold object from the
  81                         system and the object was not found.
  82                 </desc>
  83         </event>
  84
  85         <event code='1503' textcode='TRANSIT_NOT_FOUND'>
  86                 <desc>
  87                         Someone attempted to retrieve a transit object from the
  88                         system and the object was not found.
  89                 </desc>
  90         </event>
  91
  92         <event code='1503' textcode='BILLING_NOT_FOUND'>
  93                 <desc>
  94                         Someone attempted to retrieve a transit object from the
  95                         system and the object was not found.
  96                 </desc>
  97         </event>
  98
  99         <event code='1504' textcode='CONTAINER_NOT_FOUND'>
 100                 <desc>
 101                         Someone attempted to retrieve a container object from the
 102                         system and the object was not found.
 103                 </desc>
 104         </event>
 105
 106         <event code='1505' textcode='CONTAINER_ITEM_NOT_FOUND'>
 107                 <desc>
 108                         Someone attempted to retrieve a container item object from the
 109                         system and the object was not found.
 110                 </desc>
 111         </event>
 112
 113         <event code='1506' textcode='VOLUME_NOT_FOUND'>
 114                 <desc>
 115                         Someone attempted to retrieve a volume object from the
 116                         system and the object was not found.
 117                 </desc>
 118         </event>
 119
 120         <event code='1507' textcode='ORG_UNIT_NOT_FOUND'>
 121                 <desc>
 122                         Someone attempted to retrieve an org unit object from the
 123                         system and the object was not found.
 124                 </desc>
 125         </event>
 126
 127         <event code='1508' textcode='STAT_CAT_NOT_FOUND'>
 128                 <desc> Stat cat object does not exist </desc>
 129         </event>
 130
 131         <event code='1509' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
 132                 <desc> Stat cat entry object does not exist </desc>
 133         </event>
 134
 135         <event code='1510' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
 136                 <desc> Stat cat entry map object does not exist </desc>
 137         </event>
 138
 139         <event code='1511' textcode='NON_CAT_TYPE_NOT_FOUND'>
 140                 <desc> The non cataloged type object does not exist </desc>
 141         </event>
 142
 143         <event code='1512' textcode='CIRC_DURATION_NOT_FOUND'>
 144                 <desc> The circ duration object does not exist </desc>
 145         </event>
 146
 147         <event code='1513' textcode='RECURRING_FINE_NOT_FOUND'>
 148                 <desc> The recurring fines object does not exist </desc>
 149         </event>
 150
 151         <event code='1514' textcode='MAX_FINE_NOT_FOUND'>
 152                 <desc> The max fines object does not exist </desc>
 153         </event>
 154
 155         <event code='1515' textcode='COPY_LOCATION_NOT_FOUND'>
 156                 <desc> The copy location object does not exist </desc>
 157         </event>
 158
 159
 160
 161         <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
 162                 <desc> The non-cataloged type object already exists </desc>
 163         </event>
 164
 165         <event code='1701' textcode='COPY_LOCATION_EXISTS'>
 166                 <desc> The copy location object already exists </desc>
 167         </event>
 168
 169
 170         <event code='2000' textcode='BAD_PARAMS'>
 171                 <desc>
 172                         Invalid parameters were encountered in a method
 173                 </desc>
 174         </event>
 175
 176         <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
 177                 <desc>
 178                         The attempt to write to the DB failed
 179                 </desc>
 180         </event>
 181
 182
 183         <event code='5000' textcode='PERM_FAILURE'>
 184                 <desc>
 185                         Permission Error.  * The object returning this code shall also
 186                         contain a field "ilsperm" containing the name of the permission which failed
 187                         and a field called "ilspermloc" defining the location at which the permission
 188                         failed if available.
 189                 </desc>
 190         </event>
 191
 192
 193         <!-- ================================================================ -->
 194         <!-- CIRC EVENTS -->
 195         <event code='7000' textcode='ROUTE_COPY'>
 196                 <desc> A copy needs to be routed to a different location        </desc>
 197         </event>
 198
 199         <event code='7001' textcode='PATRON_BAD_STANDING'>
 200                 <desc>
 201                         The patron in question is not able to check out materials because
 202                         their account is in bad standing
 203                 </desc>
 204         </event>
 205
 206         <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
 207                 <desc>
 208                         The patron in question has the maximum number of items already checked out
 209                 </desc>
 210         </event>
 211
 212         <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
 213                 <desc> Target copy is not allowed to circulate </desc>
 214         </event>
 215
 216         <event code='7004' textcode='COPY_NOT_AVAILABLE'>
 217                 <desc> Copy is not available </desc>
 218         </event>
 219
 220         <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
 221                 <desc> Location does not allow materials to circulate </desc>
 222         </event>
 223
 224         <event code='7006' textcode='COPY_IS_REFERENCE'>
 225                 <desc> Copy is reference material </desc>
 226         </event>
 227
 228         <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
 229                 <desc> Copy is needed to fulfil a hold </desc>
 230         </event>
 231         <!-- ================================================================ -->
 232
 233 </ils_events>
 234
 235
 236
 237