docs/development/data_supercat.txt

   1 Using Supercat
   2 ==============
   3
   4 Introduction
   5 ------------
   6
   7 You can use SuperCat to get data about ISBNs, metarecords, bibliographic
   8 records, and authority records.
   9
  10 Throughout this section, replace <hostname> with the domain or subdomain
  11 of your Evergreen installation to try these examples on your own system.
  12
  13 ISBNs
  14 -----
  15
  16 Given one ISBN, Evergreen can return a list of related records and ISBNs,
  17 including alternate editions and translations.  To use the Supercat
  18 oISBN tool, use http or https to access the following URL.
  19
  20 http://<hostname>/opac/extras/oisbn/<ISBN_to_query>
  21
  22 For example, the URL http://gapines.org/opac/extras/oisbn/0439136350 returns
  23 the following list of catalog record IDs and ISBNs:
  24
  25 [source,xml]
  26 ----------------------------------------------------------------------------
  27 <?xml version='1.0' encoding='UTF-8' ?>
  28 <idlist metarecord='436139'>
  29   <isbn record='5652044'>9780606323475</isbn>
  30   <isbn record='5767568'>9780780673809</isbn>
  31   <isbn record='1350528'>9780807286029</isbn>
  32   <isbn record='5708164'>9780780669642</isbn>
  33   <isbn record='2372013'>043965548X</isbn>
  34   <isbn record='5804511'>8498386969</isbn>
  35   <isbn record='4132282'>9780786222742</isbn>
  36   <isbn record='1530458'>9788478885190</isbn>
  37   <isbn record='2003291'>0736650962</isbn>
  38   <isbn record='1993002'>8478885196</isbn>
  39   <isbn record='1187595'>9780439554923</isbn>
  40   <isbn record='4591175'>8478885196</isbn>
  41   <isbn record='5676282'>0807282324</isbn>
  42   <isbn record='2363352'>8478885196</isbn>
  43   <isbn record='2315122'>1480614998</isbn>
  44   <isbn record='2304130'>8478886559</isbn>
  45   <isbn record='2012565'>9780613371063</isbn>
  46   <isbn record='5763645'>9782070528189</isbn>
  47   <isbn record='2383286'>0786222743</isbn>
  48   <isbn record='2489670'>9780329232696</isbn>
  49   <isbn record='1681685'>9780807282311</isbn>
  50   <isbn record='2160095'>0807286028</isbn>
  51   <isbn record='2219885'>9789500421157</isbn>
  52   <isbn record='1934218'>9780613359580</isbn>
  53   <isbn record='5682871'>9781594130021</isbn>
  54   <isbn record='1281164'>0807283150</isbn>
  55   <isbn record='1666656'>0747542155</isbn>
  56   <isbn record='4717734'>8478886559</isbn>
  57 </idlist>
  58 ----------------------------------------------------------------------------
  59
  60 Records
  61 -------
  62
  63 Record formats
  64 ~~~~~~~~~~~~~~
  65
  66 First, determine which format you'd like to receive data in.  To see the
  67 available formats for bibliographic records, visit
  68 http://<hostname>/opac/extras/supercat/formats/record
  69
  70 Similarly, authority record formats can be found at
  71 http://libcat.linnbenton.edu/opac/extras/supercat/formats/authority
  72 and metarecord formats can be found at
  73 http://libcat.linnbenton.edu/opac/extras/supercat/formats/metarecord
  74
  75 For example, http://gapines.org/opac/extras/supercat/formats/authority
  76 shows that the Georgia Pines catalog can return authority records in the
  77 formats _opac_, _marc21_, _marc21-full_, and _marc21-uris_.  Supercat
  78 also includes the MIME type of each format, and sometimes also refers
  79 to the documentation for a particular format.
  80
  81 [source,xml]
  82 ----------------------------------------------------------------------------
  83 <?xml version='1.0' encoding='UTF-8' ?>
  84 <formats>
  85   <format>
  86     <name>opac</name>
  87     <type>text/html</type>
  88   </format>
  89   <format>
  90     <name>marc21</name>
  91     <type>application/xml</type>
  92     <docs>http://www.loc.gov/marc/</docs>
  93   </format>
  94   <format>
  95     <name>marc21-full</name>
  96     <type>application/xml</type>
  97     <docs>http://www.loc.gov/marc/</docs>
  98   </format>
  99   <format>
 100     <name>marc21-uris</name>
 101     <type>application/xml</type>
 102     <docs>http://www.loc.gov/marc/</docs>
 103   </format>
 104 </formats>
 105 ----------------------------------------------------------------------------
 106
 107 [NOTE]
 108 ============================================================================
 109 atom-full is currently the only format that includes holdings and availability
 110 data for a given bibliographic record.
 111 ============================================================================
 112
 113
 114 Retrieve records
 115 ~~~~~~~~~~~~~~~~
 116
 117 You can retrieve records using URLs in the following format:
 118 http://<hostname>/opac/extras/supercat/retrieve/<format>/<record-type>/<record-ID>
 119
 120 For example, http://gapines.org/opac/extras/supercat/retrieve/mods/record/33333
 121 returns the following record.
 122
 123 [source,xml]
 124 ----------------------------------------------------------------------------
 125 <?xml version="1.0"?>
 126 <modsCollection xmlns="http://www.loc.gov/mods/" xmlns:mods="http://www.loc.gov/mods/" version="3.0">
 127   <mods xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mods="http://www.loc.gov/mods/" xsi:schemaLocation="http://www.loc.gov/mods/ http://www.loc.gov/standards/mods/mods.xsd">
 128     <titleInfo>
 129       <title>Words and pictures /</title>
 130     </titleInfo>
 131     <name type="personal">
 132       <namePart xmlns:xlink="http://www.w3.org/TR/xlink">Dodd, Siobhan</namePart>
 133       <role>
 134         <text>creator</text>
 135       </role>
 136     </name>
 137     <typeOfResource xmlns:xlink="http://www.w3.org/TR/xlink">text</typeOfResource>
 138     <originInfo xmlns:xlink="http://www.w3.org/TR/xlink">
 139       <place>
 140         <code authority="marc">mau</code>
 141       </place>
 142       <place>
 143         <text>Cambridge, Mass</text>
 144       </place>
 145       <publisher>Candlewick Press</publisher>
 146       <dateIssued>1992</dateIssued>
 147       <edition>1st U.S. ed.</edition>
 148       <issuance>monographic</issuance>
 149     </originInfo>
 150     <language authority="iso639-2b">eng</language>
 151     <physicalDescription>
 152       <form authority="marcform">print</form>
 153       <extent>1 v. (unpaged) : col. ill. ; 26 cm.</extent>
 154     </physicalDescription>
 155     <abstract>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.</abstract>
 156     <targetAudience>juvenile</targetAudience>
 157     <note type="statement of responsibility">Siobhan Dodds.</note>
 158     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcshac">
 159       <topic>Family life</topic>
 160       <topic>Fiction</topic>
 161     </subject>
 162     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 163       <topic>Vocabulary</topic>
 164       <topic>Juvenile fiction</topic>
 165     </subject>
 166     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 167       <topic>Rebuses</topic>
 168     </subject>
 169     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 170       <topic>Picture puzzles</topic>
 171       <topic>Juvenile literature</topic>
 172     </subject>
 173     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 174       <topic>Picture books for children</topic>
 175     </subject>
 176     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 177       <topic>Picture dictionaries, English</topic>
 178       <topic>Juvenile literature</topic>
 179     </subject>
 180     <subject xmlns:xlink="http://www.w3.org/TR/xlink" authority="lcsh">
 181       <topic>Vocabulary</topic>
 182       <topic>Juvenile literature</topic>
 183     </subject>
 184     <classification authority="lcc">PZ7.D66275 Wo 1992</classification>
 185     <classification authority="lcc">PN6371.5 .D63 1992x</classification>
 186     <classification authority="ddc" edition="20">793.73</classification>
 187     <identifier type="isbn">1564020428 :</identifier>
 188     <identifier type="isbn">9781564020420</identifier>
 189     <identifier type="lccn">91071817</identifier>
 190     <recordInfo xmlns:xlink="http://www.w3.org/TR/xlink">
 191       <recordContentSource>DLC</recordContentSource>
 192       <recordCreationDate encoding="marc">920206</recordCreationDate>
 193       <recordChangeDate encoding="iso8601">20110608231047.0</recordChangeDate>
 194       <recordIdentifier source="GaAaGPL">33333</recordIdentifier>
 195     </recordInfo>
 196   </mods>
 197 </modsCollection>
 198 ----------------------------------------------------------------------------
 199
 200 Recent records
 201 ~~~~~~~~~~~~~~
 202
 203 SuperCat can return feeds of recently edited or created authority and bibliographic records:
 204
 205 http://<hostname>/opac/extras/feed/freshmeat/<feed-type>/<record-type>/<import-or-edit>/<limit>/<date>
 206
 207 Note the following features:
 208
 209 * 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.
 210 * If you do not supply a limit, then up to 10 records will be returned.
 211 * feed-type can be one of atom, html, htmlholdings, marcxml, mods, mods3, or rss2.
 212
 213 Example: http://gapines.org/opac/extras/feed/freshmeat/atom/biblio/import/10/2008-01-01
 214
 215 Filtering by Org Unit
 216 ^^^^^^^^^^^^^^^^^^^^^
 217
 218 You can generate a similar list, with the added ability to limit by Org Unit, using the item-age browse axis.
 219
 220 To produce an RSS feed by item date rather than bib date, and to restrict it to a particular system within a consortium:
 221
 222 Example: http://gapines.org/opac/extras/browse/atom/item-age/ARL-BOG/1/10
 223
 224 Note the following:
 225
 226 * ARL-BOG should be the short name of the org unit you're interested in
 227 * 1 is the page (since you are browsing through pages of results)
 228 * 10 is the number of results to return per page
 229
 230 Modifying the 'atom' portion of the URL to 'atom-full' will include catalog links in the results:
 231
 232 Example: http://gapines.org/opac/extras/browse/atom-full/item-age/ARL-BOG/1/10
 233
 234 Modifying the 'atom' portion of the URL to 'html-full' will produce an HTML page that is minimally formatted:
 235
 236 Example: http://gapines.org/opac/extras/browse/html-full/item-age/ARL-BOG/1/10
 237
 238