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