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='1000' textcode='LOGIN_FAILED'>
19 User login failed. Why the login failed is not specified.
23 <event code='1001' textcode='NO_SESSION'>
25 User login session has either timed out or does not exist.
29 <event code='1002' textcode='USER_NOT_FOUND'>
31 Someone attempted to retrieve a user from the system and the user
36 <event code='1200' textcode='USERNAME_EXISTS'>
38 The given username exists in the database
42 <event code='1201' textcode='CIRC_PERMIT_BAD_KEY'>
44 A checkout was attempted without a valid checkout permit key
48 <event code='1202' textcode='ITEM_NOT_CATALOGED'>
50 The requested item is not cataloged in the database
57 <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
59 Someone attempted to retrieve a circulation object from the system and
60 the object was not found.
64 <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
66 Someone attempted to retrieve a biblio record entry object from the
67 system and the object was not found.
71 <event code='1502' textcode='COPY_NOT_FOUND'>
73 Someone attempted to retrieve a copy object from the
74 system and the object was not found.
78 <event code='1503' textcode='HOLD_NOT_FOUND'>
80 Someone attempted to retrieve a hold object from the
81 system and the object was not found.
85 <event code='1503' textcode='TRANSIT_NOT_FOUND'>
87 Someone attempted to retrieve a transit object from the
88 system and the object was not found.
92 <event code='1503' textcode='BILLING_NOT_FOUND'>
94 Someone attempted to retrieve a transit object from the
95 system and the object was not found.
99 <event code='1504' textcode='CONTAINER_NOT_FOUND'>
101 Someone attempted to retrieve a container object from the
102 system and the object was not found.
106 <event code='1505' textcode='CONTAINER_ITEM_NOT_FOUND'>
108 Someone attempted to retrieve a container item object from the
109 system and the object was not found.
113 <event code='1506' textcode='VOLUME_NOT_FOUND'>
115 Someone attempted to retrieve a volume object from the
116 system and the object was not found.
120 <event code='1507' textcode='ORG_UNIT_NOT_FOUND'>
122 Someone attempted to retrieve an org unit object from the
123 system and the object was not found.
127 <event code='1508' textcode='STAT_CAT_NOT_FOUND'>
128 <desc> Stat cat object does not exist </desc>
131 <event code='1509' textcode='STAT_CAT_ENTRY_NOT_FOUND'>
132 <desc> Stat cat entry object does not exist </desc>
135 <event code='1510' textcode='STAT_CAT_ENTRY_MAP_NOT_FOUND'>
136 <desc> Stat cat entry map object does not exist </desc>
139 <event code='1511' textcode='NON_CAT_TYPE_NOT_FOUND'>
140 <desc> The non cataloged type object does not exist </desc>
143 <event code='1512' textcode='CIRC_DURATION_NOT_FOUND'>
144 <desc> The circ duration object does not exist </desc>
147 <event code='1513' textcode='RECURRING_FINE_NOT_FOUND'>
148 <desc> The recurring fines object does not exist </desc>
151 <event code='1514' textcode='MAX_FINE_NOT_FOUND'>
152 <desc> The max fines object does not exist </desc>
155 <event code='1515' textcode='COPY_LOCATION_NOT_FOUND'>
156 <desc> The copy location object does not exist </desc>
161 <event code='1700' textcode='NON_CAT_TYPE_EXISTS'>
162 <desc> The non-cataloged type object already exists </desc>
165 <event code='1701' textcode='COPY_LOCATION_EXISTS'>
166 <desc> The copy location object already exists </desc>
169 <event code='1702' textcode='OPEN_CIRCULATION_EXISTS'>
170 <desc> There is an open circulation on the requested item </desc>
174 <event code='2000' textcode='BAD_PARAMS'>
176 Invalid parameters were encountered in a method
180 <event code='2001' textcode='DATABASE_UPDATE_FAILED'>
182 The attempt to write to the DB failed
187 <event code='5000' textcode='PERM_FAILURE'>
189 Permission Error. * The object returning this code shall also
190 contain a field "ilsperm" containing the name of the permission which failed
191 and a field called "ilspermloc" defining the location at which the permission
197 <!-- ================================================================ -->
199 <event code='7000' textcode='ROUTE_COPY'>
200 <desc> A copy needs to be routed to a different location </desc>
203 <event code='7001' textcode='PATRON_BAD_STANDING'>
205 The patron in question is not able to check out materials because
206 their account is in bad standing
210 <event code='7002' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
212 The patron in question has the maximum number of items already checked out
216 <event code='7003' textcode='COPY_CIRC_NOT_ALLOWED'>
217 <desc> Target copy is not allowed to circulate </desc>
220 <event code='7004' textcode='COPY_NOT_AVAILABLE'>
221 <desc> Copy is not available </desc>
224 <event code='7005' textcode='LOCATION_CIRC_NOT_ALLOWED'>
225 <desc> Location does not allow materials to circulate </desc>
228 <event code='7006' textcode='COPY_IS_REFERENCE'>
229 <desc> Copy is reference material </desc>
232 <event code='7007' textcode='COPY_NEEDED_FOR_HOLD'>
233 <desc> Copy is needed to fulfil a hold </desc>
235 <!-- ================================================================ -->