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