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
43 <event code='1500' textcode='CIRCULATION_NOT_FOUND'>
45 Someone attempted to retrieve a circulation object from the system and
46 the object was not found.
50 <event code='1501' textcode='BIBLIO_RECORD_NOT_FOUND'>
52 Someone attempted to retrieve a biblio record entry object from the
53 system and the object was not found.
57 <event code='1502' textcode='COPY_NOT_FOUND'>
59 Someone attempted to retrieve a copy object from the
60 system and the object was not found.
64 <event code='1503' textcode='HOLD_NOT_FOUND'>
66 Someone attempted to retrieve a hold object from the
67 system and the object was not found.
71 <event code='1503' textcode='TRANSIT_NOT_FOUND'>
73 Someone attempted to retrieve a transit object from the
74 system and the object was not found.
78 <event code='1503' textcode='BILLING_NOT_FOUND'>
80 Someone attempted to retrieve a transit object from the
81 system and the object was not found.
85 <event code='1504' textcode='CONTAINER_NOT_FOUND'>
87 Someone attempted to retrieve a container object from the
88 system and the object was not found.
92 <event code='1505' textcode='CONTAINER_ITEM_NOT_FOUND'>
94 Someone attempted to retrieve a container item object from the
95 system and the object was not found.
99 <event code='1506' textcode='VOLUME_NOT_FOUND'>
101 Someone attempted to retrieve a volume object from the
102 system and the object was not found.
108 <!-- ================================================================ -->
110 <event code='1700' textcode='ROUTE_COPY'>
111 <desc> A copy needs to be routed to a different location </desc>
114 <event code='1701' textcode='PATRON_BAD_STANDING'>
116 The patron in question is not able to check out materials because
117 their account is in bad standing
121 <event code='1702' textcode='PATRON_EXCEEDS_CHECKOUT_COUNT'>
123 The patron in question has the maximum number of items already checked out
127 <event code='1703' textcode='COPY_CIRC_NOT_ALLOWED'>
128 <desc> Target copy is not allowed to circulate </desc>
131 <event code='1704' textcode='COPY_NOT_AVAILABLE'>
132 <desc> Copy is not available </desc>
135 <event code='1705' textcode='LOCATION_CIRC_NOT_ALLOWED'>
136 <desc> Location does not allow materials to circulate </desc>
139 <event code='1706' textcode='COPY_IS_REFERENCE'>
140 <desc> Copy is reference material </desc>
143 <event code='1707' textcode='COPY_NEEDED_FOR_HOLD'>
144 <desc> Copy is needed to fulfil a hold </desc>
146 <!-- ================================================================ -->
149 <event code='2000' textcode='BAD_PARAMS'>
151 Invalid parameters were encountered in a method
155 <event code='5000' textcode='PERM_FAILURE'>
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