documentation:technical:opacapi

Table of Contents

Common OPAC API Calls (As of 2010-02-10)

Common OPAC API Calls (As of 2010-02-10)

Bib Searching

open-ils.search.biblio.multiclass.query[.staff]
open-ils.search.biblio.multiclass[.staff]
open-ils.search.metabib.multiclass.query[.staff]
open-ils.search.metabib.multiclass[.staff]
open-ils.search.biblio.isbn
open-ils.search.biblio.issn
open-ils.search.biblio.marc[.staff]
open-ils.search.biblio.tcn

Retrieving Bib Records

open-ils.search.biblio.metarecord.copy_count[.staff]
open-ils.search.biblio.metarecord.mods_slim.retrieve
open-ils.search.biblio.metarecord_to_records[.staff]
open-ils.search.biblio.mods_from_copy
open-ils.search.biblio.record.copy_count[.staff]
open-ils.search.biblio.record_entry.slim.retrieve
open-ils.search.biblio.record.mods_slim.retrieve
open-ils.search.bib_id.by_barcode

Fetching/Browsing Call Numbers, Copies, Copy Status, etc.

open-ils.search.asset.call_number.retrieve
open-ils.search.asset.copy.fleshed2.retrieve
open-ils.search.asset.copy.retrieve
open-ils.search.asset.copy.retrieve_by_cn_label[.staff]
open-ils.search.call_number.retrieve_by_info
open-ils.search.config.copy_status.retrieve.all
open-ils.search.biblio.copy_counts.summary.retrieve
open-ils.search.biblio.copy_location_counts.summary.retrieve
open-ils.search.callnumber.browse
open-ils.circ.copy_location.retrieve.all
open-ils.circ.copy_note.retrieve.all

Authority Cross Ref

open-ils.search.authority.crossref
open-ils.search.authority.crossref.batch

MARC Bib Mappings

open-ils.search.biblio.audience_map.retrieve.all
open-ils.search.biblio.bib_level_map.retrieve.all
open-ils.search.biblio.item_form_map.retrieve.all
open-ils.search.biblio.item_type_map.retrieve.all
open-ils.search.biblio.lit_form_map.retrieve.all
open-ils.search.metabib.record_to_descriptors

Miscellaneous

open-ils.search.biblio.record.html
open-ils.search.spellcheck
open-ils.circ.asset.stat_cat_entries.fleshed.retrieve_by_copy

Buckets / Bookbags

open-ils.actor.container.create
open-ils.actor.container.flesh
open-ils.actor.container.full_delete
open-ils.actor.container.item.create
open-ils.actor.container.item.delete
open-ils.actor.container.public.flesh
open-ils.actor.container.retrieve_by_class
open-ils.actor.container.retrieve_by_class
open-ils.actor.container.update

Authentication

open-ils.auth.authenticate.complete
open-ils.auth.authenticate.init
open-ils.auth.session.delete
open-ils.auth.session.retrieve

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