bug fixes after testing
[Evergreen.git] / 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
43         <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
44                 <desc>
45                         Someone attempted to retrieve a circulation object from the system and 
46                         the object was not found.
47                 </desc>
48         </event>
49
50         <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
51                 <desc>
52                         Someone attempted to retrieve a biblio record entry object from the 
53                         system and the object was not found.
54                 </desc>
55         </event>
56
57         <event code='1502' textcode='COPY_NOT_FOUND'>
58                 <desc>
59                         Someone attempted to retrieve a copy object from the 
60                         system and the object was not found.
61                 </desc>
62         </event>
63
64         <event code='1503' textcode='HOLD_NOT_FOUND'>
65                 <desc>
66                         Someone attempted to retrieve a hold object from the 
67                         system and the object was not found.
68                 </desc>
69         </event>
70
71         <event code='1503' textcode='TRANSIT_NOT_FOUND'>
72                 <desc>
73                         Someone attempted to retrieve a transit object from the 
74                         system and the object was not found.
75                 </desc>
76         </event>
77
78         <event code='1503' textcode='BILLING_NOT_FOUND'>
79                 <desc>
80                         Someone attempted to retrieve a transit object from the 
81                         system and the object was not found.
82                 </desc>
83         </event>
84
85         <event code='1504' textcode='CONTAINER_NOT_FOUND'>
86                 <desc>
87                         Someone attempted to retrieve a container object from the 
88                         system and the object was not found.
89                 </desc>
90         </event>
91
92         <event code='1505' textcode='CONTAINER_ITEM_NOT_FOUND'>
93                 <desc>
94                         Someone attempted to retrieve a container item object from the 
95                         system and the object was not found.
96                 </desc>
97         </event>
98
99         <event code='1506' textcode='VOLUME_NOT_FOUND'>
100                 <desc>
101                         Someone attempted to retrieve a volume object from the 
102                         system and the object was not found.
103                 </desc>
104         </event>
105
106
107
108         <!-- ================================================================ -->
109         <!-- CIRC EVENTS -->
110         <event code='1700' textcode='ROUTE_COPY'>
111                 <desc> A copy needs to be routed to a different location        </desc>
112         </event>
113
114         <event code='1701' textcode='PATRON_BAD_STANDING'>
115                 <desc>
116                         The patron in question is not able to check out materials because
117                         their account is in bad standing
118                 </desc>
119         </event>
120
121         <event code='1702' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
122                 <desc>
123                         The patron in question has the maximum number of items already checked out
124                 </desc>
125         </event>
126
127         <event code='1703' textcode='COPY_CIRC_NOT_ALLOWED'>
128                 <desc> Target copy is not allowed to circulate </desc>
129         </event>
130
131         <event code='1704' textcode='COPY_NOT_AVAILABLE'>
132                 <desc> Copy is not available </desc>
133         </event>
134
135         <event code='1705' textcode='LOCATION_CIRC_NOT_ALLOWED'>
136                 <desc> Location does not allow materials to circulate </desc>
137         </event>
138
139         <event code='1706' textcode='COPY_IS_REFERENCE'>
140                 <desc> Copy is reference material </desc>
141         </event>
142
143         <event code='1707' textcode='COPY_NEEDED_FOR_HOLD'>
144                 <desc> Copy is needed to fulfil a hold </desc>
145         </event>
146         <!-- ================================================================ -->
147
148
149         <event code='2000' textcode='BAD_PARAMS'>
150                 <desc>
151                         Invalid parameters were encountered in a method
152                 </desc>
153         </event>
154
155         <event code='5000' textcode='PERM_FAILURE'>
156                 <desc> 
157                         Permission Error.  * The object returning this code shall also 
158                         contain a field "ilsperm" containing the name of the permission which failed 
159                         and a field called "ilspermloc" defining the location at which the permission
160                         failed if available.
161                 </desc>
162         </event>
163 </ils_events>
164
165
166
167