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='1000' textcode='LOGIN_FAILED'>
  17                 <desc>
  18                         User login failed.  Why the login failed is not specified.
  19                 </desc>
  20         </event>
  21
  22         <event code='1001' textcode='NO_SESSION'>
  23                 <desc>
  24                         User login session has either timed out or does not exist.
  25                 </desc>
  26         </event>
  27
  28         <event code='1002' textcode='USER_NOT_FOUND'>
  29                 <desc>
  30                         Someone attempted to retrieve a user from the system and the user
  31                         was not found.
  32                 </desc>
  33         </event>
  34
  35         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
  36                 <desc>
  37                         Someone attempted to retrieve a circulation object from the system and
  38                         the object was not found.
  39                 </desc>
  40         </event>
  41
  42         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
  43                 <desc>
  44                         Someone attempted to retrieve a biblio record entry object from the
  45                         system and the object was not found.
  46                 </desc>
  47         </event>
  48
  49         <event code='1502' textcode='COPY_NOT_FOUND'>
  50                 <desc>
  51                         Someone attempted to retrieve a copy object from the
  52                         system and the object was not found.
  53                 </desc>
  54         </event>
  55
  56         <event code='1503' textcode='HOLD_NOT_FOUND'>
  57                 <desc>
  58                         Someone attempted to retrieve a hold object from the
  59                         system and the object was not found.
  60                 </desc>
  61         </event>
  62
  63         <event code='1503' textcode='TRANSIT_NOT_FOUND'>
  64                 <desc>
  65                         Someone attempted to retrieve a transit object from the
  66                         system and the object was not found.
  67                 </desc>
  68         </event>
  69
  70
  71
  72         <event code='2000' textcode='BAD_PARAMS'>
  73                 <desc>
  74                         Invalid parameters were encountered in a method
  75                 </desc>
  76         </event>
  77
  78         <event code='5000' textcode='PERM_FAILURE'>
  79                 <desc>
  80                         Permission Error.  * The object returning this code shall also
  81                         contain a field "ilsperm" containing the name of the permission which failed
  82                         and a field called "ilspermloc" defining the location at which the permission
  83                         failed if available.
  84                 </desc>
  85         </event>
  86 </ils_events>
  87
  88
  89
  90