From 19b55c3a2d10bad4dfa2c84ea2397814f037e9e9 Mon Sep 17 00:00:00 2001 From: Jane Sandberg Date: Tue, 20 Dec 2016 09:32:34 -0800 Subject: [PATCH] Docs: Adding information about Supercat and UnAPI --- docs/development/data_supercat.txt | 238 +++++++++++++++++++++++++++++ docs/development/data_unapi.txt | 67 ++++++++ docs/root.txt | 21 +++ 3 files changed, 326 insertions(+) create mode 100644 docs/development/data_supercat.txt create mode 100644 docs/development/data_unapi.txt diff --git a/docs/development/data_supercat.txt b/docs/development/data_supercat.txt new file mode 100644 index 0000000000..f0a9d17954 --- /dev/null +++ b/docs/development/data_supercat.txt @@ -0,0 +1,238 @@ +Using Supercat +============== + +Introduction +------------ + +You can use SuperCat to get data about ISBNs, metarecords, bibliographic +records, and authority records. + +Throughout this section, replace with the domain or subdomain +of your Evergreen installation to try these examples on your own system. + +ISBNs +----- + +Given one ISBN, Evergreen can return a list of related records and ISBNs, +including alternate editions and translations. To use the Supercat +oISBN tool, use http or https to access the following URL. + +http:///opac/extras/oisbn/ + +For example, the URL http://gapines.org/opac/extras/oisbn/0439136350 returns +the following list of catalog record IDs and ISBNs: + +[source,xml] +---------------------------------------------------------------------------- + + + 9780606323475 + 9780780673809 + 9780807286029 + 9780780669642 + 043965548X + 8498386969 + 9780786222742 + 9788478885190 + 0736650962 + 8478885196 + 9780439554923 + 8478885196 + 0807282324 + 8478885196 + 1480614998 + 8478886559 + 9780613371063 + 9782070528189 + 0786222743 + 9780329232696 + 9780807282311 + 0807286028 + 9789500421157 + 9780613359580 + 9781594130021 + 0807283150 + 0747542155 + 8478886559 + +---------------------------------------------------------------------------- + +Records +------- + +Record formats +~~~~~~~~~~~~~~ + +First, determine which format you'd like to receive data in. To see the +available formats for bibliographic records, visit +http:///opac/extras/supercat/formats/record + +Similarly, authority record formats can be found at +http://libcat.linnbenton.edu/opac/extras/supercat/formats/authority +and metarecord formats can be found at +http://libcat.linnbenton.edu/opac/extras/supercat/formats/metarecord + +For example, http://gapines.org/opac/extras/supercat/formats/authority +shows that the Georgia Pines catalog can return authority records in the +formats _opac_, _marc21_, _marc21-full_, and _marc21-uris_. Supercat +also includes the MIME type of each format, and sometimes also refers +to the documentation for a particular format. + +[source,xml] +---------------------------------------------------------------------------- + + + + opac + text/html + + + marc21 + application/xml + http://www.loc.gov/marc/ + + + marc21-full + application/xml + http://www.loc.gov/marc/ + + + marc21-uris + application/xml + http://www.loc.gov/marc/ + + +---------------------------------------------------------------------------- + +[NOTE] +============================================================================ +atom-full is currently the only format that includes holdings and availability +data for a given bibliographic record. +============================================================================ + + +Retrieve records +~~~~~~~~~~~~~~~~ + +You can retrieve records using URLs in the following format: +http:///opac/extras/supercat/retrieve/// + +For example, http://gapines.org/opac/extras/supercat/retrieve/mods/record/33333 +returns the following record. + +[source,xml] +---------------------------------------------------------------------------- + + + + + Words and pictures / + + + Dodd, Siobhan + + creator + + + text + + + mau + + + Cambridge, Mass + + Candlewick Press + 1992 + 1st U.S. ed. + monographic + + eng + +
print
+ 1 v. (unpaged) : col. ill. ; 26 cm. + + Simple text with picture cues accompany illustrations depicting scenes of everyday life familiar to children, such as getting dressed, attending a party, playing in the park, and taking a bath. + juvenile + Siobhan Dodds. + + Family life + Fiction + + + Vocabulary + Juvenile fiction + + + Rebuses + + + Picture puzzles + Juvenile literature + + + Picture books for children + + + Picture dictionaries, English + Juvenile literature + + + Vocabulary + Juvenile literature + + PZ7.D66275 Wo 1992 + PN6371.5 .D63 1992x + 793.73 + 1564020428 : + 9781564020420 + 91071817 + + DLC + 920206 + 20110608231047.0 + 33333 + + + +---------------------------------------------------------------------------- + +Recent records +~~~~~~~~~~~~~~ + +SuperCat can return feeds of recently edited or created authority and bibliographic records: + +http:///opac/extras/feed/freshmeat///// + +Note the following features: + +* The limit records imported or edited following the supplied date will be returned. If you do not supply a date, then the most recent limit records will be returned. +* If you do not supply a limit, then up to 10 records will be returned. +* feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2. + +Example: http://gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01 + +Filtering by Org Unit +^^^^^^^^^^^^^^^^^^^^^ + +You can generate a similar list, with the added ability to limit by Org Unit, using the item-age browse axis. + +To produce an RSS feed by item date rather than bib date, and to restrict it to a particular system within a consortium: + +Example: http://gapines.org/opac/extras/browse/atom/item-age/ARL-BOG/1/10 + +Note the following: + +* ARL-BOG should be the short name of the org unit you're interested in +* 1 is the page (since you are browsing through pages of results) +* 10 is the number of results to return per page + +Modifying the 'atom' portion of the URL to 'atom-full' will include catalog links in the results: + +Example: http://gapines.org/opac/extras/browse/atom-full/item-age/ARL-BOG/1/10 + +Modifying the 'atom' portion of the URL to 'html-full' will produce an HTML page that is minimally formatted: + +Example: http://gapines.org/opac/extras/browse/html-full/item-age/ARL-BOG/1/10 + + diff --git a/docs/development/data_unapi.txt b/docs/development/data_unapi.txt new file mode 100644 index 0000000000..2e17bd8d86 --- /dev/null +++ b/docs/development/data_unapi.txt @@ -0,0 +1,67 @@ +Using UnAPI +=========== + +Evergreen's unAPI support includes access to many +record types. For example, the following URL would fetch +bib 267 in MODS32 along with holdings, volume, copy, +and record attribute information: + +https://example.org/opac/extras/unapi?id=tag::U2@bre/267{holdings_xml,acn,acp,mra}&format=mods32 + +To access the new unAPI features, the unAPI ID should have the +following form: + + * +tag::U2@+ + * followed by class name, which may be + * +bre+ (bibs) + * +biblio_record_entry_feed+ (multiple bibs) + * +acl+ (copy locations) + * +acn+ (volumes) + * +acnp+ (call number prefixes) + * +acns+ (call number suffixes) + * +acp+ (copies) + * +acpn+ (copy notes) + * +aou+ (org units) + * +ascecm+ (copy stat cat entries) + * +auri+ (located URIs) + * +bmp+ (monographic parts) + * +cbs+ (bib sources) + * +ccs+ (copy statuses) + * +circ+ (loan checkout and due dates) + * +holdings_xml+ (holdings) + * +mmr+ (metarecords) + * +mmr_holdings_xml+ (metarecords with holdings) + * +mmr_mra+ (metarecords with record attributes) + * +mra+ (record attributes) + * +sbsum+ (serial basic summaries) + * +sdist+ (serial distributions) + * +siss+ (serial issues) + * +sisum+ (serial index summaries) + * +sitem+ (serial items) + * +sssum+ (serial supplement summaries) + * +sstr+ (serial streams) + * +ssub+ (serial subscriptions) + * +sunit+ (serial units) + * followed by +/+ + * followed by a record identifier (or in the case of + the +biblio_record_entry_feed+ class, multiple IDs separated + by commas) + * followed, optionally, by limit and offset in square brackets + * followed, optionally, by a comma-separated list of "includes" + enclosed in curly brackets. The list of includes is + the same as the list of classes with the following addition: + * +bre.extern+ (information from the non-MARC parts of a bib + record) + * followed, optionally, by +/+ and org unit; "-" signifies + the top of the org unit tree + * followed, optionally, by +/+ and org unit depth + * followed, optionally, by +/+ and a path. If the path + is +barcode+ and the class is +acp+, the record ID is taken + to be a copy barcode rather than a copy ID; for example, in + +tag::U2@acp/ACQ140{acn,bre,mra}/-/0/barcode+, +ACQ140+ is + meant to be a copy barcode. + * followed, optionally, by +&format=+ and the format in which the record + should be retrieved. If this part is omitted, the list of available + formats will be retrieved. + + diff --git a/docs/root.txt b/docs/root.txt index d1eee95fe7..e5b7576327 100644 --- a/docs/root.txt +++ b/docs/root.txt @@ -609,6 +609,27 @@ include::development/updating_translations_launchpad.txt[] // Return to normal title levels. :leveloffset: 0 + +Getting Data from Evergreen +=========================== + +Introduction +------------ + +You may be interested in re-using data from your Evergreen installation in +another application. This part describes several methods to get the data +you need. + +// Push titles down one level. +:leveloffset: 1 + +include::development/data_supercat.txt[] + +include::development/data_unapi.txt[] + +// Return to normal title levels. +:leveloffset: 0 + include::attributions.txt[] include::licensing.txt[] -- 2.43.2