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
9 If events need to be placed into groups for any reason, the segregation shall
10 be defined below with the accompanying events.
13 <event code='0' textcode='SUCCESS'>
14 <desc>No errors or unexpected events occurred</desc>
17 <event code='1' textcode='UNKNOWN'>
18 <desc>Placeholder event. Used for development only</desc>
22 <event code='1000' textcode='LOGIN_FAILED'>
24 User login failed. Why the login failed is not specified.
28 <event code='1001' textcode='NO_SESSION'>
30 User login session has either timed out or does not exist.
34 <event code='1002' textcode='USER_NOT_FOUND'>
36 Someone attempted to retrieve a user from the system and the user
41 <event code='1200' textcode='USERNAME_EXISTS'>
43 The given username exists in the database
47 <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
49 A checkout was attempted without a valid checkout permit key
53 <event code='1202' textcode='ITEM_NOT_CATALOGED'>
55 The requested item is not cataloged in the database
59 <event code='1203' textcode='COPY_BAD_STATUS'>
61 The given copy is not in a standard circulation status
65 <event code='1204' textcode='CIRC_BAD_STATUS'>
67 The given circulation is not in a standard status or
68 the circulation was never fully closed properly
77 <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
79 Someone attempted to retrieve a circulation object from the system and
80 the object was not found.
84 <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
86 Someone attempted to retrieve a biblio record entry object from the
87 system and the object was not found.
91 <event code='1502' textcode='COPY_NOT_FOUND'>
93 Someone attempted to retrieve a copy object from the
94 system and the object was not found.
98 <event code='1503' textcode='HOLD_NOT_FOUND'>
100 Someone attempted to retrieve a hold object from the
101 system and the object was not found.
105 <event code='1504' textcode='TRANSIT_NOT_FOUND'>
107 Someone attempted to retrieve a transit object from the
108 system and the object was not found.
112 <event code='1505' textcode='BILLING_NOT_FOUND'>
114 Someone attempted to retrieve a transit object from the
115 system and the object was not found.
119 <event code='1506' textcode='CONTAINER_NOT_FOUND'>
121 Someone attempted to retrieve a container object from the
122 system and the object was not found.
126 <event code='1507' textcode='CONTAINER_ITEM_NOT_FOUND'>
128 Someone attempted to retrieve a container item object from the
129 system and the object was not found.
133 <event code='1508' textcode='VOLUME_NOT_FOUND'>
135 Someone attempted to retrieve a volume object from the
136 system and the object was not found.
140 <event code='1509' textcode='ORG_UNIT_NOT_FOUND'>
142 Someone attempted to retrieve an org unit object from the
143 system and the object was not found.
147 <event code='1510' textcode='STAT_CAT_NOT_FOUND'>
148 <desc> Stat cat object does not exist </desc>
151 <event code='1511' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
152 <desc> Stat cat entry object does not exist </desc>
155 <event code='1512' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
156 <desc> Stat cat entry map object does not exist </desc>
159 <event code='1513' textcode='NON_CAT_TYPE_NOT_FOUND'>
160 <desc> The non cataloged type object does not exist </desc>
163 <event code='1514' textcode='CIRC_DURATION_NOT_FOUND'>
164 <desc> The circ duration object does not exist </desc>
167 <event code='1515' textcode='RECURRING_FINE_NOT_FOUND'>
168 <desc> The recurring fines object does not exist </desc>
171 <event code='1516' textcode='MAX_FINE_NOT_FOUND'>
172 <desc> The max fines object does not exist </desc>
175 <event code='1517' textcode='COPY_LOCATION_NOT_FOUND'>
176 <desc> The copy location object does not exist </desc>
179 <event code='1518' textcode='HOLD_TRANSIT_NOT_FOUND'>
180 <desc> The hold transit object does not exist </desc>
186 <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
187 <desc> The non-cataloged type object already exists </desc>
190 <event code='1701' textcode='COPY_LOCATION_EXISTS'>
191 <desc> The copy location object already exists </desc>
194 <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
195 <desc> There is an open circulation on the requested item </desc>
199 <event code='2000' textcode='BAD_PARAMS'>
201 Invalid parameters were encountered in a method
205 <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
207 The attempt to write to the DB failed
212 <event code='5000' textcode='PERM_FAILURE'>
214 Permission Error. * The object returning this code shall also
215 contain a field "ilsperm" containing the name of the permission which failed
216 and a field called "ilspermloc" defining the location at which the permission
222 <!-- ================================================================ -->
224 <event code='7000' textcode='ROUTE_ITEM'>
226 A copy needs to be routed to a different location
227 The destination location will be specified by an 'org' key
228 within the event object
232 <event code='7001' textcode='PATRON_BAD_STANDING'>
234 The patron in question is not able to check out materials because
235 their account is in bad standing
239 <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
241 The patron in question has the maximum number of items already checked out
245 <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
246 <desc> Target copy is not allowed to circulate </desc>
249 <event code='7004' textcode='COPY_NOT_AVAILABLE'>
250 <desc> Copy is not available </desc>
253 <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
254 <desc> Location does not allow materials to circulate </desc>
257 <event code='7006' textcode='COPY_IS_REFERENCE'>
258 <desc> Copy is reference material </desc>
261 <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
262 <desc> Copy is needed to fulfil a hold </desc>
265 <event code='7008' textcode='MAX_RENEWALS_REACHED'>
266 <desc> Circulation has no more renewals remaining </desc>
269 <event code='7009' textcode='ROUTE_TO_COPY_LOCATION'>
271 A copy needs to be routed to a copy location. The location
272 should be specified within the event with a 'location' key
276 <!-- ================================================================ -->