This file describes the event codes that an ILS method might return. Not all
methods will return event codes and it is up to each method to define which
types of events it may return. The standard event procedure is to return an
object (JSON hash) with a field called "ilsevent" which contains the event code
below.
If events need to be placed into groups for any reason, the segregation shall
be defined below with the accompanying events.
Placeholder event. Used for development only
No change occurred
User login failed
User login session has either timed out or does not exist
Someone attempted to retrieve a user from the system and the user was not found
The Z search did not succeed
The Z query is not formatted correctly
The given username already exists in the database
A checkout was attempted without a valid checkout permit key
The requested item is not cataloged in the database
The given copy is not in a standard circulation status
The given circulation is not in a standard status or
the circulation was never fully closed properly
The given user barcode already exists
The selected volume has copies attached
A refund greater than the negative balance on a transaction was provided
The last copy attached to a title is being removed or deleted
The login failed
The provided password is not correct
The selecte bill has already been voided
The patron has too many overdue items
The patron is barred
The selected primary identification type and value are in use by another patron
The selected copy may not circulate because the recipient's home
location is not within the copy's circulation range
The patron's card is not active
This account is marked as inactive
This item is too new to have a hold placed on it
A copy with a remote circulating library (circ_lib) was encountered
A copy with a remote circulating library (circ_lib) was encountered
The selected location cannot have volumes attached
The user does not have a valid email address assigned
The user does not have a valid phone number assigned
The patron's account has expired
The transit on this item may not be aborted due to the state the item is in
This refund amount is not allowed because it exceeds
the total amount of desk payments for this transaction.
The copy in question is not in an ideal status for deleting
The requested bib record is marked as deleted
The requested volume is marked as deleted
The saved item has been edited by another user
The selected bib record has volumes attached
Someone attempted to retrieve a circulation object from the system and
the object was not found.
The requested biblio_record_entry was not found
Someone attempted to retrieve a copy object from the
system and the object was not found.
The requested action_hold_request was not found
Someone attempted to retrieve a transit object from the
system and the object was not found.
Someone attempted to retrieve a container object from the
system and the object was not found.
Someone attempted to retrieve a container item object from the
system and the object was not found.
Requested asset_call_number was not found
The requested action_hold_transit_copy was not found
Requested workstation object does not exist
Requested title note does not exist
Requested billing note does not exist
No TCN could be found that does not collide with existing records
Requested address was not found
The requested actor_workstation was not found
The requested config_identification_type was not found
The requested action_survey_question was not found
The requested money_billable_transaction_summary was not found
The requested actor_usr_note was not found
The requested actor_user_setting was not found
The requested metabib_author_field_entry was not found
The requested action_in_house_use was not found
The requested action_survey_response was not found
The requested container_copy_bucket_item was not found
The requested authority_record_entry was not found
The requested authority_record_descriptor was not found
The requested config_language_map was not found
The requested money_credit_card_payment was not found
The requested config_metabib_field was not found
The requested perm_ex was not found
The requested config_audience_map was not found
The requested config_item_form_map was not found
The requested config_standing was not found
The requested money_open_user_summary was not found
The requested actor_org_unit_hours_of_operation was not found
The requested actor_org_unit_closed_date was not found
The requested config_rules_circ_duration was not found
The requested money_open_billable_transaction_summary was not found
The requested actor_org_unit_setting was not found
The requested asset_copy_note was not found
The requested metabib_full_rec was not found
The requested metabib_metarecord was not found
The requested permission_perm_list was not found
The requested metabib_metarecord_source_map was not found
The requested metabib_keyword_field_entry was not found
The requested money_cash_payment was not found
The requested actor_profile was not found
The requested money_forgive_payment was not found
The requested metabib_record_descriptor was not found
The requested config_copy_status was not found
The requested actor_user_standing_penalty was not found
The requested asset_call_number_note was not found
The requested authority_record_note was not found
The requested container_call_number_bucket_item was not found
The requested container_biblio_record_entry_bucket was not found
The requested ex was not found
The requested action_hold_copy_map was not found
The requested action_hold_notification was not found
The requested asset_copy_location was not found
The requested metabib_virtual_record was not found
The requested asset_stat_cat_entry_copy_map was not found
The requested config_item_type_map was not found
The requested action_survey was not found
The requested actor_org_address was not found
The requested actor_org_unit was not found
The requested container_call_number_bucket was not found
The requested asset_stat_cat was not found
The requested actor_card was not found
The requested actor_stat_cat was not found
The requested metabib_series_field_entry was not found
The requested container_user_bucket was not found
The requested money_credit_payment was not found
The requested authority_full_rec was not found
The requested config_non_cataloged_type was not found
The requested actor_org_unit_type was not found
The requested biblio_record_note was not found
The requested money_user_circulation_summary was not found
The requested money_grocery was not found
The requested config_bib_source was not found
The requested money_billable_transaction was not found
The requested actor_stat_cat_entry was not found
The requested container_user_bucket_item was not found
The requested money_user_summary was not found
The requested config_lit_form_map was not found
The requested money_work_payment was not found
The requested action_open_circulation was not found
The requested metabib_subject_field_entry was not found
The requested config_rules_recuring_fine was not found
The requested money_check_payment was not found
The requested config_rules_max_fine was not found
The requested permission_grp_tree was not found
The requested action_survey_answer was not found
The requested action_non_cataloged_circulation was not found
The requested money_open_user_circulation_summary was not found
The requested action_unfulfilled_hold_list was not found
The requested metabib_title_field_entry was not found
The requested actor_stat_cat_entry_user_map was not found
The requested permission_grp_perm_map was not found
The requested container_copy_bucket was not found
The requested biblio_record_node was not found
The requested permission_usr_perm_map was not found
The requested money_payment was not found
The requested container_biblio_record_entry_bucket_item was not found
The requested asset_stat_cat_entry was not found
The requested money_billing was not found
The requested permission_usr_grp_map was not found
The requested actor_user_note was not found
The requested money_collections_tracker was not found
The requested money_collections_tracker was not found
The requested money_collections_tracker was not found
The requested reporter_template was not found
The requested reporter_report was not found
The requested reporter_output_folder was not found
The requested reporter_report_folder was not found
The requested reporter_template_folder was not found
The requested reporter_schedule was not found
The requested actor_usr_org_unit_opt_in was not found
The requested action_open_circ_count_by_circ_mod was not found
The requested config_circ_modifier was not found
The requested vandelay_bib_queue was not found
The requested vandelay_authority_queue was not found
The requested config_circ_matrix_test was not found
The requested vandelay_queued_bib_record was not found
The requested vandelay_queued_authority_record was not found
The requested permission_usr_work_ou_map was not found
The non-cataloged type object already exists
The copy location object already exists
There is an open circulation on the requested item
A workstation with that name already exists
A record already exists with the requested TCN value
A volume with the same label, title and owning library exists
An item with the same barcode exists
User already has an open hold on the selected item
A duplicate money.collections_tracker object already exists in the database
User has reached the maximum number of holds
User has already created a bucket with the requested name
A bib record queue with the same name already exists
An authority record queue with the same name already exists
Invalid parameters were encountered in a method
The attempt to write to the DB failed
The attempt to query to the DB failed
There was an internal server error
Permission Denied
A copy needs to be routed to a different location
The destination location will be specified by an 'org' key
within the event object
The patron in question is not able to check out materials because
their account is in bad standing
The patron in question has the maximum number of items already checked out
Target copy is not allowed to circulate
Copy is not available
Location does not allow materials to circulate
Copy is reference material
Copy is needed to fulfil a hold
Circulation has no more renewals remaining
Requested circulation is marked claims returned
The requested copy has an alert message attached
Copy has is marked as lost
Copy has is marked as missing
The patron in question has reached the maximum fine amount
Copy is in transit
This requested action would result in a negative patron balance
This requested item is currently on the holds shelf
A copy needs to be routed to a copy location. The location
should be specified within the event with a 'location' key
The requested item is already marked as lost
An offline session for this location is currently processing
An offline file for this workstation exists within this session
An offline file or directory could not be created or accessed
Missing params in offline upload
Offline server is not configured properly
Offline server is not configured properly
Offline server is not configured properly
A session with the given name already exists
The session name is invalid
No org id was provided
No org id was provided
A report template with the given name and folder already exists
A report with the given name and folder already exists