docs/development/data_unapi.adoc

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