docs-antora/modules/development/pages/data_unapi.adoc

   1 = Using UnAPI =
   2 :toc:
   3
   4 == URL format ==
   5
   6 Evergreen's unAPI support includes access to many
   7 record types. For example, the following URL would fetch
   8 bib 267 in MODS32 along with holdings and record attribute information:
   9
  10 https://example.org/opac/extras/unapi?id=tag::U2@bre/267{holdings_xml,acn,acp,mra}&format=mods32
  11
  12 To access the new unAPI features, the unAPI ID should have the
  13 following form:
  14
  15   * +tag::U2@+
  16   * followed by class name, which may be
  17     ** +bre+ (bibs)
  18     ** +biblio_record_entry_feed+ (multiple bibs)
  19     ** +acl+ (shelving locations)
  20     ** +acn+ (call numbers)
  21     ** +acnp+ (call number prefixes)
  22     ** +acns+ (call number suffixes)
  23     ** +acp+ (items)
  24     ** +acpn+ (item notes)
  25     ** +aou+ (org units)
  26     ** +ascecm+ (item stat cat entries)
  27     ** +auri+ (located URIs)
  28     ** +bmp+ (monographic parts)
  29     ** +cbs+ (bib sources)
  30     ** +ccs+ (item statuses)
  31     ** +circ+ (loan checkout and due dates)
  32     ** +holdings_xml+ (holdings)
  33     ** +mmr+ (metarecords)
  34     ** +mmr_holdings_xml+ (metarecords with holdings)
  35     ** +mmr_mra+ (metarecords with record attributes)
  36     ** +mra+ (record attributes)
  37     ** +sbsum+ (serial basic summaries)
  38     ** +sdist+ (serial distributions)
  39     ** +siss+ (serial issues)
  40     ** +sisum+ (serial index summaries)
  41     ** +sitem+ (serial items)
  42     ** +sssum+ (serial supplement summaries)
  43     ** +sstr+ (serial streams)
  44     ** +ssub+ (serial subscriptions)
  45     ** +sunit+ (serial units)
  46   * followed by +/+
  47   * followed by a record identifier (or in the case of
  48     the +biblio_record_entry_feed+ class, multiple IDs separated
  49     by commas)
  50   * followed, optionally, by limit and offset in square brackets
  51   * followed, optionally, by a comma-separated list of "includes"
  52     enclosed in curly brackets.  The list of includes is
  53     the same as the list of classes with the following addition:
  54     ** +bre.extern+ (information from the non-MARC parts of a bib
  55       record)
  56    * followed, optionally, by +/+ and org unit; "-" signifies
  57      the top of the org unit tree
  58    * followed, optionally, by +/+ and org unit depth
  59    * followed, optionally, by +/+ and a path. If the path
  60      is +barcode+ and the class is +acp+, the record ID is taken
  61      to be an item barcode rather than an item ID; for example, in
  62      +tag::U2@acp/ACQ140{acn,bre,mra}/-/0/barcode+, +ACQ140+ is
  63      meant to be an item barcode.
  64    * followed, optionally, by +&format=+ and the format in which the record
  65      should be retrieved. If this part is omitted, the list of available
  66      formats will be retrieved.
  67
  68