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='5000' textcode='PERM_FAILURE'>
  29                 <desc>
  30                         Permission Error.  * The object returning this code shall also
  31                         contain a field "ilsperm" containing the name of the permission which failed
  32                         and a field called "ilspermloc" defining the location at which the permission
  33                         failed if available.
  34                 </desc>
  35         </event>
  36 </ils_events>
  37
  38
  39
  40