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>
16 <event code='1' textcode='UNKNOWN'>
17 <desc>Placeholder event. Used for development only</desc>
19 <event code='3' textcode='NO_CHANGE'>
21 The called method didn't actually do anything
24 <event code='1000' textcode='LOGIN_FAILED'>
26 User login failed. Why the login failed is not specified.
29 <event code='1001' textcode='NO_SESSION'>
31 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
40 <event code='1003' textcode='Z3950_SEARCH_FAILED'>
41 <desc>The Z search did not succeed</desc>
43 <event code='1200' textcode='USERNAME_EXISTS'>
45 The given username exists in the database
48 <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
50 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
58 <event code='1203' textcode='COPY_BAD_STATUS'>
60 The given copy is not in a standard circulation status
63 <event code='1204' textcode='CIRC_BAD_STATUS'>
65 The given circulation is not in a standard status or
66 the circulation was never fully closed properly
73 <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
75 Someone attempted to retrieve a circulation object from the system and
76 the object was not found.
79 <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
81 Someone attempted to retrieve a biblio record entry object from the
82 system and the object was not found.
85 <event code='1502' textcode='COPY_NOT_FOUND'>
87 Someone attempted to retrieve a copy object from the
88 system and the object was not found.
91 <event code='1503' textcode='HOLD_NOT_FOUND'>
93 Someone attempted to retrieve a hold object from the
94 system and the object was not found.
97 <event code='1504' textcode='TRANSIT_NOT_FOUND'>
99 Someone attempted to retrieve a transit object from the
100 system and the object was not found.
103 <event code='1505' textcode='BILLING_NOT_FOUND'>
105 Someone attempted to retrieve a transit object from the
106 system and the object was not found.
109 <event code='1506' textcode='CONTAINER_NOT_FOUND'>
111 Someone attempted to retrieve a container object from the
112 system and the object was not found.
115 <event code='1507' textcode='CONTAINER_ITEM_NOT_FOUND'>
117 Someone attempted to retrieve a container item object from the
118 system and the object was not found.
121 <event code='1508' textcode='VOLUME_NOT_FOUND'>
123 Someone attempted to retrieve a volume object from the
124 system and the object was not found.
127 <event code='1509' textcode='ORG_UNIT_NOT_FOUND'>
129 Someone attempted to retrieve an org unit object from the
130 system and the object was not found.
133 <event code='1510' textcode='STAT_CAT_NOT_FOUND'>
134 <desc> Stat cat object does not exist </desc>
136 <event code='1511' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
137 <desc> Stat cat entry object does not exist </desc>
139 <event code='1512' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
140 <desc> Stat cat entry map object does not exist </desc>
142 <event code='1513' textcode='NON_CAT_TYPE_NOT_FOUND'>
143 <desc> The non cataloged type object does not exist </desc>
145 <event code='1514' textcode='CIRC_DURATION_NOT_FOUND'>
146 <desc> The circ duration object does not exist </desc>
148 <event code='1515' textcode='RECURRING_FINE_NOT_FOUND'>
149 <desc> The recurring fines object does not exist </desc>
151 <event code='1516' textcode='MAX_FINE_NOT_FOUND'>
152 <desc> The max fines object does not exist </desc>
154 <event code='1517' textcode='COPY_LOCATION_NOT_FOUND'>
155 <desc> The copy location object does not exist </desc>
157 <event code='1518' textcode='HOLD_TRANSIT_NOT_FOUND'>
158 <desc> The hold transit object does not exist </desc>
160 <event code='1519' textcode='TRANSACTION_NOT_FOUND'>
161 <desc> Requested transaction object does not exist </desc>
163 <event code='1520' textcode='WORKSTATION_NOT_FOUND'>
164 <desc> Requested workstation object does not exist </desc>
166 <event code='1521' textcode='COPY_NOTE_NOT_FOUND'>
167 <desc> Requested copy note does not exist </desc>
169 <event code='1522' textcode='VOLUME_NOTE_NOT_FOUND'>
170 <desc> Requested copy note does not exist </desc>
172 <event code='1523' textcode='TITLE_NOTE_NOT_FOUND'>
173 <desc> Requested copy note does not exist </desc>
179 <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
180 <desc> The non-cataloged type object already exists </desc>
183 <event code='1701' textcode='COPY_LOCATION_EXISTS'>
184 <desc> The copy location object already exists </desc>
187 <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
188 <desc> There is an open circulation on the requested item </desc>
191 <event code='1702' textcode='WORKSTATION_NAME_EXISTS'>
192 <desc> A workstation with that name already exists </desc>
196 <event code='2000' textcode='BAD_PARAMS'>
198 Invalid parameters were encountered in a method
202 <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
204 The attempt to write to the DB failed
209 <event code='5000' textcode='PERM_FAILURE'>
211 Permission Error. * The object returning this code shall also
212 contain a field "ilsperm" containing the name of the permission which failed
213 and a field called "ilspermloc" defining the location at which the permission
219 <!-- ================================================================ -->
221 <event code='7000' textcode='ROUTE_ITEM'>
223 A copy needs to be routed to a different location
224 The destination location will be specified by an 'org' key
225 within the event object
229 <event code='7001' textcode='PATRON_BAD_STANDING'>
231 The patron in question is not able to check out materials because
232 their account is in bad standing
236 <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
238 The patron in question has the maximum number of items already checked out
242 <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
243 <desc> Target copy is not allowed to circulate </desc>
246 <event code='7004' textcode='COPY_NOT_AVAILABLE'>
247 <desc> Copy is not available </desc>
250 <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
251 <desc> Location does not allow materials to circulate </desc>
254 <event code='7006' textcode='COPY_IS_REFERENCE'>
255 <desc> Copy is reference material </desc>
258 <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
259 <desc> Copy is needed to fulfil a hold </desc>
262 <event code='7008' textcode='MAX_RENEWALS_REACHED'>
263 <desc> Circulation has no more renewals remaining </desc>
266 <event code='7009' textcode='ROUTE_TO_COPY_LOCATION'>
268 A copy needs to be routed to a copy location. The location
269 should be specified within the event with a 'location' key
273 <event code='8000' textcode='OFFLINE_SESSION_ACTIVE'>
274 <desc> An offline session for this location is currently processing </desc>
276 <event code='8001' textcode='OFFLINE_SESSION_FILE_EXISTS'>
277 <desc> An offline file for this workstation exists within this session </desc>
279 <event code='8002' textcode='OFFLINE_FILE_ERROR'>
280 <desc> An offline file or directory could not be created or accessed </desc>
282 <event code='8003' textcode='OFFLINE_PARAM_ERROR'>
283 <desc> Missing params in offline upload </desc>
285 <event code='8003' textcode='OFFLINE_CONFIG_ERROR'>
286 <desc> Offline server is not configured properly </desc>
289 <!-- ================================================================ -->