Evergreen DokuWiki

User Tools

Site Tools

You are here: start » documentation » technical » opacapi
documentation:technical:opacapi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
documentation:technical:opacapi [2010/02/10 10:13] – most commonly used opac methods. plan is to provide descriptoins of params and return values. probably some will be trimmed out in time since they are duplicates ericksondocumentation:technical:opacapi [2022/02/10 13:34] (current) – external edit 127.0.0.1
Line 1: Line 1:
-open-ils.search:open-ils.search.metabib.multiclass[.staff]                  +=====Common OPAC API Calls (As of 2010-02-10)=====                                                                                
-open-ils.search:open-ils.search.biblio.multiclass[.staff]                   + 
-open-ils.search:open-ils.search.metabib.multiclass.query[.staff]            +=== Bib Searching ===   
-open-ils.search:open-ils.search.biblio.multiclass.query[.staff]                    + 
-open-ils.search:open-ils.search.biblio.record.class.search[.staff]                 +  * open-ils.search.biblio.multiclass.query[.staff]                    
-open-ils.search:open-ils.search.biblio.metarecord.mods_slim.retrieve               +  * open-ils.search.biblio.multiclass[.staff]                          
-open-ils.search:open-ils.search.biblio.mods_from_copy                                +  * open-ils.search.metabib.multiclass.query[.staff]                   
-open-ils.search:open-ils.search.biblio.metarecord.copy_count[.staff]                       +  * open-ils.search.metabib.multiclass[.staff]                         
-open-ils.search:open-ils.search.biblio.metarecord_to_records[.staff]                       +  * open-ils.search.biblio.isbn                                          
-open-ils.search:open-ils.search.biblio.record.mods_slim.retrieve                           +  * open-ils.search.biblio.issn                                          
-open-ils.search:open-ils.search.biblio.record.copy_count[.staff]                           +  * open-ils.search.biblio.marc[.staff]                                        
-open-ils.actor:open-ils.actor.user.fleshed.retrieve                                        +  * open-ils.search.biblio.tcn                                                 
-open-ils.auth:open-ils.auth.session.retrieve                                               + 
-open-ils.auth:open-ils.auth.authenticate.init                                              +=== Retrieving Bib Records === 
-open-ils.auth:open-ils.auth.authenticate.complete                                          + 
-open-ils.auth:open-ils.auth.session.delete                                                 +  * open-ils.search.biblio.metarecord.copy_count[.staff]                       
-open-ils.actor:open-ils.actor.patron.settings.retrieve                                     +  * open-ils.search.biblio.metarecord.mods_slim.retrieve                       
-open-ils.actor:open-ils.actor.patron.settings.update                                       +  * open-ils.search.biblio.metarecord_to_records[.staff]                       
-open-ils.search:open-ils.search.config.copy_status.retrieve.all                            +  * open-ils.search.biblio.mods_from_copy                                      
-open-ils.search:open-ils.search.biblio.copy_location_counts.summary.retrieve               +  * open-ils.search.biblio.record.copy_count[.staff]                           
-open-ils.search:open-ils.search.biblio.copy_counts.summary.retrieve                          +  * open-ils.search.biblio.record_entry.slim.retrieve                          
-open-ils.search:open-ils.search.biblio.record.html                                           +  * open-ils.search.biblio.record.mods_slim.retrieve                           
-open-ils.actor:open-ils.actor.user.checked_out                                               +  * open-ils.search.bib_id.by_barcode                                                
-open-ils.circ:open-ils.circ.holds.retrieve                                                   + 
-open-ils.actor:open-ils.actor.user.fines.summary                                             +=== Fetching/Browsing Call Numbers, Copies, Copy Status, etc. === 
-open-ils.actor:open-ils.actor.user.transactions.have_charge.fleshed                          + 
-open-ils.circ:open-ils.circ.money.billing.retrieve.all                                       +  * open-ils.search.asset.call_number.retrieve           
-open-ils.search:open-ils.search.authority.crossref                                           +  * open-ils.search.asset.copy.fleshed2.retrieve                         
-open-ils.search:open-ils.search.authority.crossref.batch                                     +  * open-ils.search.asset.copy.retrieve                                  
-open-ils.circ:open-ils.circ.holds.create                                                     +  * open-ils.search.asset.copy.retrieve_by_cn_label[.staff]                            
-open-ils.circ:open-ils.circ.holds.create.override                                            +  * open-ils.search.call_number.retrieve_by_info                                       
-open-ils.circ:open-ils.circ.hold.cancel                                                      +  * open-ils.search.config.copy_status.retrieve.all                                    
-open-ils.actor:open-ils.actor.user.username.update                                           +  * open-ils.search.biblio.copy_counts.summary.retrieve                                
-open-ils.actor:open-ils.actor.user.password.update                                           +  * open-ils.search.biblio.copy_location_counts.summary.retrieve                       
-open-ils.actor:open-ils.actor.user.email.update                                              +  * open-ils.search.callnumber.browse                                                  
-open-ils.circ:open-ils.circ.renew                                                            +  * open-ils.circ.copy_location.retrieve.all                                           
-open-ils.search:open-ils.search.spellcheck                                                   +  * open-ils.circ.copy_note.retrieve.all                                               
-open-ils.actor:open-ils.actor.user.fleshed.retrieve_by_barcode                               + 
-open-ils.search:open-ils.search.biblio.marc[.staff]                                          + 
-open-ils.search:open-ils.search.biblio.isbn +=== Authority Cross Ref === 
-open-ils.search:open-ils.search.biblio.issn + 
-open-ils.search:open-ils.search.biblio.tcn +  * open-ils.search.authority.crossref                           
-open-ils.search:open-ils.search.callnumber.browse +  * open-ils.search.authority.crossref.batch                             
-open-ils.actor:open-ils.actor.container.retrieve_by_class + 
-open-ils.actor:open-ils.actor.container.retrieve_by_class +=== MARC Bib Mappings === 
-open-ils.actor:open-ils.actor.container.create + 
-open-ils.actor:open-ils.actor.container.full_delete +  * open-ils.search.biblio.audience_map.retrieve.all             
-open-ils.actor:open-ils.actor.container.item.create +  * open-ils.search.biblio.bib_level_map.retrieve.all            
-open-ils.actor:open-ils.actor.container.item.delete +  * open-ils.search.biblio.item_form_map.retrieve.all            
-open-ils.actor:open-ils.actor.container.flesh +  * open-ils.search.biblio.item_type_map.retrieve.all            
-open-ils.actor:open-ils.actor.container.public.flesh +  * open-ils.search.biblio.lit_form_map.retrieve.all             
-open-ils.actor:open-ils.actor.container.update +  * open-ils.search.metabib.record_to_descriptors                        
-open-ils.search:open-ils.search.asset.copy.retrieve + 
-open-ils.search:open-ils.search.asset.copy.fleshed2.retrieve +=== Miscellaneous === 
-open-ils.circ:open-ils.circ.title_hold.is_possible + 
-open-ils.circ:open-ils.circ.hold.update +  * open-ils.search.biblio.record.html                           
-open-ils.search:open-ils.search.asset.copy.retrieve_by_cn_label[.staff] +  * open-ils.search.spellcheck                                   
-open-ils.search:open-ils.search.call_number.retrieve_by_info +  * open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy          
-open-ils.search:open-ils.search.asset.call_number.retrieve + 
-open-ils.circ:open-ils.circ.copy_location.retrieve.all +=== Buckets / Bookbags === 
-open-ils.circ:open-ils.circ.copy_note.retrieve.all + 
-open-ils.circ:open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy +  * open-ils.actor.container.create                               
-open-ils.search:open-ils.search.biblio.lit_form_map.retrieve.all +  * open-ils.actor.container.flesh                                
-open-ils.search:open-ils.search.biblio.item_form_map.retrieve.all +  * open-ils.actor.container.full_delete                          
-open-ils.search:open-ils.search.biblio.item_type_map.retrieve.all +  * open-ils.actor.container.item.create                                  
-open-ils.search:open-ils.search.biblio.bib_level_map.retrieve.all +  * open-ils.actor.container.item.delete                                  
-open-ils.search:open-ils.search.biblio.audience_map.retrieve.all +  * open-ils.actor.container.public.flesh                                 
-open-ils.circ:open-ils.circ.hold.queue_stats.retrieve +  * open-ils.actor.container.retrieve_by_class                            
-open-ils.circ:open-ils.circ.open_non_cataloged_circulation.user +  * open-ils.actor.container.retrieve_by_class                            
-open-ils.circ:open-ils.circ.non_cataloged_circulation.retrieve +  * open-ils.actor.container.update                                       
-open-ils.circ:open-ils.circ.non_cat_types.retrieve.all + 
-open-ils.search:open-ils.search.biblio.record_entry.slim.retrieve + 
-open-ils.actor:open-ils.actor.username.exists +=== Authentication === 
-open-ils.circ:open-ils.circ.retrieve + 
-open-ils.search:open-ils.search.metabib.record_to_descriptors +  * open-ils.auth.authenticate.complete                            
-open-ils.actor:open-ils.actor.user.perm.highest_org.batch +  * open-ils.auth.authenticate.init                                
-open-ils.actor:open-ils.actor.note.retrieve.all +  * open-ils.auth.session.delete                                   
-open-ils.actor:open-ils.actor.org_unit.retrieve_by_shorname +  * open-ils.auth.session.retrieve                                 
-open-ils.search:open-ils.search.bib_id.by_barcode + 
-open-ils.actor:open-ils.actor.ou_setting.ancestor_default+=== User Account Data and Settings === 
 + 
 +  * open-ils.actor.note.retrieve.all 
 +  * open-ils.actor.patron.settings.retrieve 
 +  * open-ils.actor.patron.settings.update 
 +  * open-ils.actor.user.email.update 
 +  * open-ils.actor.user.username.update 
 +  * open-ils.actor.user.password.update 
 +  * open-ils.actor.username.exists 
 +  * open-ils.actor.user.fleshed.retrieve 
 +  * open-ils.actor.user.fleshed.retrieve_by_barcode 
 + 
 +=== User Transaction Data === 
 + 
 +  * open-ils.actor.user.fines.summary 
 +  * open-ils.actor.user.perm.highest_org.batch 
 +  * open-ils.actor.user.transactions.have_charge.fleshed 
 +  * open-ils.actor.user.checked_out 
 +  * open-ils.circ.money.billing.retrieve.all 
 +  * open-ils.circ.non_cataloged_circulation.retrieve 
 +  * open-ils.circ.non_cat_types.retrieve.all 
 +  * open-ils.circ.open_non_cataloged_circulation.user 
 +  * open-ils.circ.renew 
 +  * open-ils.circ.retrieve 
 + 
 +=== User Holds === 
 + 
 +  * open-ils.circ.hold.cancel 
 +  * open-ils.circ.hold.queue_stats.retrieve 
 +  * open-ils.circ.holds.test_and_create.batch 
 +  * open-ils.circ.holds.test_and_create.batch.override 
 +  * open-ils.circ.holds.retrieve 
 +  * open-ils.circ.hold.update 
 + 
 + 
 +=== Library Data === 
 + 
 +  * open-ils.actor.org_unit.retrieve_by_shortname 
 +  * open-ils.actor.ou_setting.ancestor_default
  
documentation/technical/opacapi.1265814801.txt.gz · Last modified: 2022/02/10 13:33 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.