@biblioteksentralen/bmdb-search 0.0.0-beta.72 → 0.0.0-beta.74
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{index-B3HuWC-m.d.cts → index-CVJjkWB5.d.ts} +419 -397
- package/dist/{index-B3HuWC-m.d.ts → index-H2sfQhnU.d.cts} +636 -398
- package/dist/index.cjs +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/server/index.d.cts +2 -2
- package/dist/server/index.d.ts +2 -2
- package/dist/v1/index.cjs +1 -1
- package/dist/v1/index.d.cts +1 -1
- package/dist/v1/index.d.ts +1 -1
- package/dist/v1/index.js +1 -2
- package/dist/v1-Blzc_Gn2.js +15194 -0
- package/dist/v1-C_OZojnA.cjs +15632 -0
- package/package.json +10 -15
- package/dist/v1-C7okMv1u.js +0 -5493
- package/dist/v1-CHqH4chp.cjs +0 -5567
|
@@ -25,7 +25,6 @@ interface paths {
|
|
|
25
25
|
* Example:
|
|
26
26
|
*
|
|
27
27
|
* `/cordata/v1/global/works/search?query=bølgene&filter[literature_type]=skjønnlitteratur&facet=work_type,genre&size=10`
|
|
28
|
-
*
|
|
29
28
|
*/
|
|
30
29
|
get: operations["searchWorks"];
|
|
31
30
|
put?: never;
|
|
@@ -48,7 +47,6 @@ interface paths {
|
|
|
48
47
|
* @description Fetch full `Work` records by BMDB work ID. Each work includes its expressions and
|
|
49
48
|
* manifestations. Results are limited to the search profile's catalogues and digital
|
|
50
49
|
* services.
|
|
51
|
-
*
|
|
52
50
|
*/
|
|
53
51
|
get: operations["getWorks"];
|
|
54
52
|
put?: never;
|
|
@@ -82,7 +80,6 @@ interface paths {
|
|
|
82
80
|
* Example — continue:
|
|
83
81
|
*
|
|
84
82
|
* `/cordata/v1/global/works/harvest?resumptionToken=<token from previous response>`
|
|
85
|
-
*
|
|
86
83
|
*/
|
|
87
84
|
get: operations["harvestWorks"];
|
|
88
85
|
put?: never;
|
|
@@ -106,7 +103,6 @@ interface paths {
|
|
|
106
103
|
*
|
|
107
104
|
* Start with `from`. Continue with `resumptionToken` until the response has none.
|
|
108
105
|
* `from` and `resumptionToken` cannot be combined.
|
|
109
|
-
*
|
|
110
106
|
*/
|
|
111
107
|
get: operations["harvestWorkIds"];
|
|
112
108
|
put?: never;
|
|
@@ -131,7 +127,6 @@ interface paths {
|
|
|
131
127
|
* Filters are AND'ed together. All filters except `catalogue` accept comma-separated
|
|
132
128
|
* values that are OR'ed together. Default sort is relevance when `query` is set,
|
|
133
129
|
* otherwise last update (newest first).
|
|
134
|
-
*
|
|
135
130
|
*/
|
|
136
131
|
get: operations["searchAgents"];
|
|
137
132
|
put?: never;
|
|
@@ -153,7 +148,6 @@ interface paths {
|
|
|
153
148
|
* Get agents
|
|
154
149
|
* @description Fetch full agent records (`Person`, `CollectiveAgent` or `ArtificialAgent`) by BMDB
|
|
155
150
|
* agent ID.
|
|
156
|
-
*
|
|
157
151
|
*/
|
|
158
152
|
get: operations["getAgents"];
|
|
159
153
|
put?: never;
|
|
@@ -178,7 +172,6 @@ interface paths {
|
|
|
178
172
|
* Filters are AND'ed together. All filters except `catalogue` accept comma-separated
|
|
179
173
|
* values that are OR'ed together. Default sort is relevance when `query` is set,
|
|
180
174
|
* otherwise last update (newest first).
|
|
181
|
-
*
|
|
182
175
|
*/
|
|
183
176
|
get: operations["searchCollections"];
|
|
184
177
|
put?: never;
|
|
@@ -200,7 +193,6 @@ interface paths {
|
|
|
200
193
|
* Get collections
|
|
201
194
|
* @description Fetch full `CollectionWork` records by BMDB collection ID, including collection
|
|
202
195
|
* expressions.
|
|
203
|
-
*
|
|
204
196
|
*/
|
|
205
197
|
get: operations["getCollections"];
|
|
206
198
|
put?: never;
|
|
@@ -231,7 +223,6 @@ interface paths {
|
|
|
231
223
|
* Example:
|
|
232
224
|
*
|
|
233
225
|
* `/cordata/v1/global/subjects/search?query=hunder&filter[type]=concept&facet=catalogue&size=10`
|
|
234
|
-
*
|
|
235
226
|
*/
|
|
236
227
|
get: operations["searchSubjects"];
|
|
237
228
|
put?: never;
|
|
@@ -253,7 +244,6 @@ interface paths {
|
|
|
253
244
|
* Get subjects
|
|
254
245
|
* @description Fetch full `Subject` records by BMDB subject ID. Each subject is a concept, place,
|
|
255
246
|
* event, person, collective agent, work or collection.
|
|
256
|
-
*
|
|
257
247
|
*/
|
|
258
248
|
get: operations["getSubjects"];
|
|
259
249
|
put?: never;
|
|
@@ -294,7 +284,6 @@ interface paths {
|
|
|
294
284
|
* Example — global profile (manifestation IDs):
|
|
295
285
|
*
|
|
296
286
|
* `/cordata/v1/global/catalogue-records?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6`
|
|
297
|
-
*
|
|
298
287
|
*/
|
|
299
288
|
get: operations["getCatalogueRecords"];
|
|
300
289
|
put?: never;
|
|
@@ -325,7 +314,6 @@ interface paths {
|
|
|
325
314
|
* Example:
|
|
326
315
|
*
|
|
327
316
|
* `/cordata/v1/global/suggestions/search?query=synt&filter[entity_type]=work,subject&size=10`
|
|
328
|
-
*
|
|
329
317
|
*/
|
|
330
318
|
get: operations["searchSuggestions"];
|
|
331
319
|
put?: never;
|
|
@@ -353,7 +341,6 @@ interface paths {
|
|
|
353
341
|
* libraries.
|
|
354
342
|
*
|
|
355
343
|
* This route sits under `/cordata/v1` today; it may later move outside that prefix.
|
|
356
|
-
*
|
|
357
344
|
*/
|
|
358
345
|
get: operations["getSearchProfiles"];
|
|
359
346
|
put?: never;
|
|
@@ -563,22 +550,23 @@ interface components {
|
|
|
563
550
|
/** @description Identifier for the work in the Internet Movie Database (IMDb). */
|
|
564
551
|
imdbId?: string;
|
|
565
552
|
};
|
|
566
|
-
/**
|
|
553
|
+
/**
|
|
554
|
+
* @description Imported library catalogue records are attempted matched to existing entities from central cataloging environments, such as Biblioteksentralen and Bokbasen. When the match fails, we generate entities from the records; these might change or disappear in the future and are marked as unstable.
|
|
567
555
|
* If a record does not match, it is often due to incomplete metadata in the catalogue record or that the resource has not been previously registered. We are continuously working to improve the matching algorithms.
|
|
568
|
-
|
|
556
|
+
*/
|
|
569
557
|
IsUnstable: boolean;
|
|
570
|
-
/**
|
|
558
|
+
/**
|
|
559
|
+
* @description A Work is defined as "The intellectual or artistic content of a distinct creation" (from the Library Reference Model).
|
|
571
560
|
* It is the top level and most abstract entity in the WEMI stack (Work, Expression, Manifestation, Item), and serves to cluster all expressions of what one could consider "the same book" (or e.g. same play, film, game, etc.) in different formats and languages.
|
|
572
|
-
* While the work is an abstract entity, convention is to assign it a title, language and year in order to aid with identifying the work.
|
|
561
|
+
* While the work is an abstract entity, convention is to assign it a title, language and year in order to aid with identifying the work.
|
|
562
|
+
*/
|
|
573
563
|
BaseWork: {
|
|
574
564
|
identifiers: components["schemas"]["WorkIdentifiers"];
|
|
575
565
|
/** @description The year in which the representative expression of the work was published or released. */
|
|
576
566
|
workYear?: number;
|
|
577
|
-
/** @description Whether this is a short work such as a short story, typically published as part of a containing manifestation rather than on its own.
|
|
578
|
-
* */
|
|
567
|
+
/** @description Whether this is a short work such as a short story, typically published as part of a containing manifestation rather than on its own. */
|
|
579
568
|
isShortWork: boolean;
|
|
580
|
-
/** @description The work contains aggregate manifestations but would not usually be thought of as a separate or original work, e.g. a one-time publication of several collected works.
|
|
581
|
-
* */
|
|
569
|
+
/** @description The work contains aggregate manifestations but would not usually be thought of as a separate or original work, e.g. a one-time publication of several collected works. */
|
|
582
570
|
isVirtualAggregatingWork?: boolean;
|
|
583
571
|
/**
|
|
584
572
|
* @deprecated
|
|
@@ -593,7 +581,8 @@ interface components {
|
|
|
593
581
|
code: components["schemas"]["CordataEnumWorkTypeCode"];
|
|
594
582
|
label: string;
|
|
595
583
|
};
|
|
596
|
-
/**
|
|
584
|
+
/**
|
|
585
|
+
* @description Uniform title for a music work.
|
|
597
586
|
*
|
|
598
587
|
* This type of title is used to provide a unique and structured point of access for classical music works that lack a distinct title, and is constructed from key information about the work.
|
|
599
588
|
*
|
|
@@ -602,57 +591,74 @@ interface components {
|
|
|
602
591
|
* ```
|
|
603
592
|
* - # "Sonatas, piano, no. 13, op. 27, no. 1, E major" { "titleType": "uniform_title_music", "form": "Sonatas", "medium": "piano", "serialNumber": "no. 13", "opusNumber": "op. 27, no. 1", "key": "E major" }
|
|
604
593
|
*
|
|
605
|
-
* - # "Konserter, fiolin, orkester, op. 8, nr. 1, RV 269, E-dur" { "titleType": "uniform_title_music", "form": "Konserter", "medium": "fiolin, orkester", "opusNumber": "op. 8, nr. 1", "thematicCatalogueNumber": "RV 269", "key": "E-dur" } ```
|
|
594
|
+
* - # "Konserter, fiolin, orkester, op. 8, nr. 1, RV 269, E-dur" { "titleType": "uniform_title_music", "form": "Konserter", "medium": "fiolin, orkester", "opusNumber": "op. 8, nr. 1", "thematicCatalogueNumber": "RV 269", "key": "E-dur" } ```
|
|
595
|
+
*/
|
|
606
596
|
UniformTitleMusic: {
|
|
607
597
|
/** @constant */
|
|
608
598
|
titleType: "uniform_title_music";
|
|
609
|
-
/**
|
|
599
|
+
/**
|
|
600
|
+
* @description Form of composition.
|
|
610
601
|
*
|
|
611
|
-
* Examples: "Symfonier" (Symphonies), "Konserter" (Concerts), Preludier (Preludes), "Sonater" (Sonatas).
|
|
602
|
+
* Examples: "Symfonier" (Symphonies), "Konserter" (Concerts), Preludier (Preludes), "Sonater" (Sonatas).
|
|
603
|
+
*/
|
|
612
604
|
form: string;
|
|
613
|
-
/**
|
|
605
|
+
/**
|
|
606
|
+
* @description Instrumentation / medium of performance (Norwegian: "Besetning").
|
|
614
607
|
*
|
|
615
608
|
* Examples: "klaver, orkester", "fiolin (2), klaver".
|
|
616
609
|
*
|
|
617
610
|
* Note that instrumentation is also coded in a structured form on `Work`.
|
|
618
611
|
*
|
|
619
|
-
* Corresponds to `240$m` in MARC 21.
|
|
612
|
+
* Corresponds to `240$m` in MARC 21.
|
|
613
|
+
*/
|
|
620
614
|
instrumentation?: string;
|
|
621
|
-
/**
|
|
615
|
+
/**
|
|
616
|
+
* @description A number used for works with the same `form` (and `instrumentation`) which are consecutively numbered by the composer or arranger, or are consecutively numbered in reference sources.
|
|
622
617
|
*
|
|
623
618
|
* Example: "nr. 14"
|
|
624
619
|
*
|
|
625
|
-
* Corresponds to parts of `240$n` in MARC 21, [musicSerialNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicSerialNumber) in Bibframe and [has serial number of musical work](https://www.rdaregistry.info/Elements/w/#P10334) in RDA.
|
|
620
|
+
* Corresponds to parts of `240$n` in MARC 21, [musicSerialNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicSerialNumber) in Bibframe and [has serial number of musical work](https://www.rdaregistry.info/Elements/w/#P10334) in RDA.
|
|
621
|
+
*/
|
|
626
622
|
serialNumber?: string;
|
|
627
|
-
/**
|
|
623
|
+
/**
|
|
624
|
+
* @description Opus number
|
|
628
625
|
*
|
|
629
626
|
* Numeric designation of a musical work assigned by a composer, publisher, or a musicologist. Includes the prefix "op .".
|
|
630
627
|
*
|
|
631
628
|
* Examples: "op. 14", "op. 27, no. 1" or "op. 27, no. 1-2"
|
|
632
629
|
*
|
|
633
|
-
* Corresponds to parts of `240$n` in MARC 21, [musicOpusNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicOpusNumber) in Bibframe and [has opus number](https://www.rdaregistry.info/Elements/w/#P10333) in RDA.
|
|
630
|
+
* Corresponds to parts of `240$n` in MARC 21, [musicOpusNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicOpusNumber) in Bibframe and [has opus number](https://www.rdaregistry.info/Elements/w/#P10333) in RDA.
|
|
631
|
+
*/
|
|
634
632
|
opusNumber?: string;
|
|
635
|
-
/**
|
|
633
|
+
/**
|
|
634
|
+
* @description Thematic catalogue number
|
|
636
635
|
*
|
|
637
636
|
* Designation for a musical work as found in a thematic catalogue of works. In cases of multiple catalogue numbers, the numbers are separated by comma.
|
|
638
637
|
*
|
|
639
638
|
* Examples: "KV 622", "BWV 249", "Sz. 75, BB 84"
|
|
640
639
|
*
|
|
641
|
-
* Corresponds to parts of `240$n` in MARC 21, [musicThematicNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicThematicNumber) in Bibframe and [has thematic index number](https://www.rdaregistry.info/Elements/w/#P10335) in RDA.
|
|
640
|
+
* Corresponds to parts of `240$n` in MARC 21, [musicThematicNumber](http://id.loc.gov/ontologies/bibframe.html#p_musicThematicNumber) in Bibframe and [has thematic index number](https://www.rdaregistry.info/Elements/w/#P10335) in RDA.
|
|
641
|
+
*/
|
|
642
642
|
thematicCatalogueNumber?: string;
|
|
643
|
-
/**
|
|
643
|
+
/**
|
|
644
|
+
* @description Designation for a part/section (Norwegian: "Seksjon") of a work used in the title.
|
|
644
645
|
*
|
|
645
|
-
* Examples: "Adagio" (part of a symphony or sonata), "Suite nr. 1", "Utvalg"
|
|
646
|
+
* Examples: "Adagio" (part of a symphony or sonata), "Suite nr. 1", "Utvalg"
|
|
647
|
+
*/
|
|
646
648
|
part?: string;
|
|
647
|
-
/**
|
|
649
|
+
/**
|
|
650
|
+
* @description Key (Norwegian: "Toneart")
|
|
648
651
|
*
|
|
649
652
|
* Examples: "C-dur", "a-moll", "F-dur"
|
|
650
653
|
*
|
|
651
|
-
* Corresponds to `240$r` in MARC 21, [musicKey](http://id.loc.gov/ontologies/bibframe.html#p_musicKey) in Bibframe and [has key of representative expression](https://www.rdaregistry.info/Elements/w/#P10221) in RDA.
|
|
654
|
+
* Corresponds to `240$r` in MARC 21, [musicKey](http://id.loc.gov/ontologies/bibframe.html#p_musicKey) in Bibframe and [has key of representative expression](https://www.rdaregistry.info/Elements/w/#P10221) in RDA.
|
|
655
|
+
*/
|
|
652
656
|
key?: string;
|
|
653
|
-
/**
|
|
657
|
+
/**
|
|
658
|
+
* @description Arrangement statement. Contains the value "arr.", "arrangement" or similar if the work is an arrangement of another work.
|
|
654
659
|
*
|
|
655
|
-
* Corresponds to `240$o` in MARC 21
|
|
660
|
+
* Corresponds to `240$o` in MARC 21
|
|
661
|
+
*/
|
|
656
662
|
arrangement?: string;
|
|
657
663
|
/** @description Language used to encode the title elements. Usually the preferred language of the cataloguing agency. */
|
|
658
664
|
titleLanguage?: components["schemas"]["Language"];
|
|
@@ -723,8 +729,7 @@ interface components {
|
|
|
723
729
|
collectiveAgentType?: components["schemas"]["CordataEnumCollectiveAgentTypeTranslated"];
|
|
724
730
|
id: components["schemas"]["Id"];
|
|
725
731
|
identifiers: components["schemas"]["AgentIdentifiers"];
|
|
726
|
-
/** @description Preferred display name of the agent in direct order (for a person, typically "Firstname Lastname"). See `catalogueName` for the inverted sorting form.
|
|
727
|
-
* */
|
|
732
|
+
/** @description Preferred display name of the agent in direct order (for a person, typically "Firstname Lastname"). See `catalogueName` for the inverted sorting form. */
|
|
728
733
|
name: string;
|
|
729
734
|
/** @description The moniker written in sorting order according to bibliographic convention, typically inverted as "Lastname, Firstname". */
|
|
730
735
|
catalogueName?: string;
|
|
@@ -784,32 +789,33 @@ interface components {
|
|
|
784
789
|
/** @description Identifier assigned by Biblioteksentralen for authority records. Unique for all authorities independent of type. */
|
|
785
790
|
bibbiAuthorityId?: string;
|
|
786
791
|
};
|
|
787
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
788
|
-
* */
|
|
792
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
789
793
|
collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
|
|
790
|
-
/**
|
|
794
|
+
/**
|
|
795
|
+
* @description Preferred title of Collection work.
|
|
791
796
|
*
|
|
792
|
-
* See Title for individual components of title.
|
|
797
|
+
* See Title for individual components of title.
|
|
798
|
+
*/
|
|
793
799
|
preferredTitle: components["schemas"]["TitleSummary"];
|
|
794
800
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
795
801
|
};
|
|
796
|
-
/** @description Collection membership of a work in search results, including optional series numbering.
|
|
797
|
-
* */
|
|
802
|
+
/** @description Collection membership of a work in search results, including optional series numbering. */
|
|
798
803
|
WorkSummaryCollectionEntry: {
|
|
799
804
|
collection: components["schemas"]["WorkSummaryCollection"];
|
|
800
|
-
/**
|
|
805
|
+
/**
|
|
806
|
+
* @description The position of this entity in the collection/series.
|
|
801
807
|
*
|
|
802
808
|
* Currently extracted from numbering assigned to Manifestations, which may collect more than one expression.
|
|
803
809
|
*
|
|
804
810
|
* The value can take one of the following forms:
|
|
805
811
|
* - a single number (e.g. "1", "2"). This is the most common case.
|
|
806
812
|
* - a range (e.g. "1-2") that covers multiple parts of the series.
|
|
807
|
-
* - a decimal number for cases where a single logical part has been split into multiple physical parts (e.g. "1.2" or "2022.1").
|
|
813
|
+
* - a decimal number for cases where a single logical part has been split into multiple physical parts (e.g. "1.2" or "2022.1").
|
|
814
|
+
*/
|
|
808
815
|
numberInSeries?: string;
|
|
809
816
|
};
|
|
810
817
|
Kulturfond: {
|
|
811
|
-
/** @description True if the manifestation is approved for library distribution through Innkjøpsordningane for litteratur.
|
|
812
|
-
* */
|
|
818
|
+
/** @description True if the manifestation is approved for library distribution through Innkjøpsordningane for litteratur. */
|
|
813
819
|
status: boolean;
|
|
814
820
|
/** @description Kulturfond scheme code, when known. */
|
|
815
821
|
program?: string;
|
|
@@ -817,7 +823,6 @@ interface components {
|
|
|
817
823
|
/**
|
|
818
824
|
* WorkSummary
|
|
819
825
|
* @description Compact work record returned by work search. Includes work-level metadata, a representative manifestation for display, and the formats available. Fetch `GET /{searchProfile}/works` for the full work with all expressions and manifestations.
|
|
820
|
-
*
|
|
821
826
|
*/
|
|
822
827
|
WorkSummary: {
|
|
823
828
|
/** @constant */
|
|
@@ -825,8 +830,7 @@ interface components {
|
|
|
825
830
|
/** @constant */
|
|
826
831
|
entityType: "work";
|
|
827
832
|
id: components["schemas"]["Id"];
|
|
828
|
-
/** @description Representative manifestation chosen for display in search results.
|
|
829
|
-
* */
|
|
833
|
+
/** @description Representative manifestation chosen for display in search results. */
|
|
830
834
|
representation: {
|
|
831
835
|
/** @description BMDB ID of the representative manifestation. */
|
|
832
836
|
manifestationId: components["schemas"]["Id"];
|
|
@@ -836,16 +840,15 @@ interface components {
|
|
|
836
840
|
title: components["schemas"]["TitleSummary"];
|
|
837
841
|
/** @description URL of the cover image of the representative manifestation, if available. */
|
|
838
842
|
coverImage?: string;
|
|
839
|
-
/** @description Catalogue record IDs for the representative manifestation, for example `b:tonsberg:123`.
|
|
840
|
-
* */
|
|
843
|
+
/** @description Catalogue record IDs for the representative manifestation, for example `b:tonsberg:123`. */
|
|
841
844
|
catalogueRecords: string[];
|
|
842
|
-
/** @description Digital-service record IDs for the representative manifestation, for example `filmoteket:123`.
|
|
843
|
-
* */
|
|
845
|
+
/** @description Digital-service record IDs for the representative manifestation, for example `filmoteket:123`. */
|
|
844
846
|
digitalServiceRecords: string[];
|
|
845
847
|
};
|
|
846
848
|
} & components["schemas"]["BaseWork"] & {
|
|
847
849
|
workType: components["schemas"]["CordataEnumWorkTypeTranslated"];
|
|
848
|
-
/**
|
|
850
|
+
/**
|
|
851
|
+
* @description Preferred title of work.
|
|
849
852
|
*
|
|
850
853
|
* Typically this will be the title the work was assigned at its first publication or release. Exceptions are made if:
|
|
851
854
|
* - the work is significantly more well known under a later or abbreviated form of the title; e.g. *"Hamlet"*, not *"The tragedy of Hamlet, prince of Denmark"*.
|
|
@@ -855,10 +858,9 @@ interface components {
|
|
|
855
858
|
* For works where the first publication has two main titles separated by "or" (subsequent main title), only the first title is registered as the preferred title for the work, e.g. *"The hobbit"*, not *"The hobbit, or, There and back again"*.
|
|
856
859
|
*
|
|
857
860
|
* Classical music works without titles in the traditional sense will instead get a generic uniform title, synthesized from key information about the work, such as "Symphonies, no. 6, op. 6, F major". In these cases, the title is of type UniformTitleMusic.
|
|
858
|
-
|
|
861
|
+
*/
|
|
859
862
|
workTitle: components["schemas"]["TitleSummary"] | components["schemas"]["UniformTitleMusic"];
|
|
860
|
-
/** @description Expression types and manifestation mediums available for this work. Used to show which formats a library can offer (for example book/print and audiobook). `platforms` is set for video games.
|
|
861
|
-
* */
|
|
863
|
+
/** @description Expression types and manifestation mediums available for this work. Used to show which formats a library can offer (for example book/print and audiobook). `platforms` is set for video games. */
|
|
862
864
|
formats: {
|
|
863
865
|
expressionType: components["schemas"]["CordataEnumExpressionTypeTranslated"];
|
|
864
866
|
manifestationMediums: components["schemas"]["CordataEnumManifestationMediumTranslated"][];
|
|
@@ -866,8 +868,7 @@ interface components {
|
|
|
866
868
|
}[];
|
|
867
869
|
literatureType?: components["schemas"]["LiteratureTypeTranslated"];
|
|
868
870
|
illustrations?: components["schemas"]["CordataEnumWorkIllustrationsOptionTranslated"];
|
|
869
|
-
/** @description Languages of the work's expressions. Each inner array is the language set of one expression.
|
|
870
|
-
* */
|
|
871
|
+
/** @description Languages of the work's expressions. Each inner array is the language set of one expression. */
|
|
871
872
|
languages: components["schemas"]["Language"][][];
|
|
872
873
|
/** @description Form terms for the work (genre entries with `isForm: true`). */
|
|
873
874
|
forms?: {
|
|
@@ -906,15 +907,15 @@ interface components {
|
|
|
906
907
|
nbVokUri?: string;
|
|
907
908
|
};
|
|
908
909
|
})[];
|
|
909
|
-
/**
|
|
910
|
+
/**
|
|
911
|
+
* @description List of contributors to the *work* in the form of *agents* (persons or organizations) and their *roles* in the creation of the work.
|
|
910
912
|
*
|
|
911
|
-
* Work contributors include authors for books, editors for edited works, composers for music, directors and screenwriters for films, etc., but not contributors that played a role in the creation of a specific expression (e.g. translators, illustrators, etc.) or manifestation (e.g. illustrators, cover designers, etc.).
|
|
913
|
+
* Work contributors include authors for books, editors for edited works, composers for music, directors and screenwriters for films, etc., but not contributors that played a role in the creation of a specific expression (e.g. translators, illustrators, etc.) or manifestation (e.g. illustrators, cover designers, etc.).
|
|
914
|
+
*/
|
|
912
915
|
contributors: components["schemas"]["WorkSummaryContributor"][];
|
|
913
|
-
/** @description Collections (typically series) the representative expression belongs to. Publisher-assigned manifestation series are not included.
|
|
914
|
-
* */
|
|
916
|
+
/** @description Collections (typically series) the representative expression belongs to. Publisher-assigned manifestation series are not included. */
|
|
915
917
|
collections?: components["schemas"]["WorkSummaryCollectionEntry"][];
|
|
916
|
-
/** @description Whether any manifestation of the work has been approved by Arts Council Norway (Kulturrådet) for library distribution through Innkjøpsordningane for litteratur.
|
|
917
|
-
* */
|
|
918
|
+
/** @description Whether any manifestation of the work has been approved by Arts Council Norway (Kulturrådet) for library distribution through Innkjøpsordningane for litteratur. */
|
|
918
919
|
kulturfond?: components["schemas"]["Kulturfond"];
|
|
919
920
|
};
|
|
920
921
|
/** @description If this is false, we haven't reached the end of the search result yet, if it's false we have, and if it's missing or null we don't know. */
|
|
@@ -943,8 +944,7 @@ interface components {
|
|
|
943
944
|
* @enum {string}
|
|
944
945
|
*/
|
|
945
946
|
queryType: "empty" | "standard" | "phrase" | "advanced";
|
|
946
|
-
/** @description Parsing error from an advanced search query. When these occur, the request is treated as a standard search.
|
|
947
|
-
* */
|
|
947
|
+
/** @description Parsing error from an advanced search query. When these occur, the request is treated as a standard search. */
|
|
948
948
|
AdvancedQueryError: {
|
|
949
949
|
/**
|
|
950
950
|
* @description Machine-readable error code.
|
|
@@ -977,8 +977,7 @@ interface components {
|
|
|
977
977
|
type: "https://search.bmdb.no/problems/search-profile-not-found";
|
|
978
978
|
/** @enum {string} */
|
|
979
979
|
title: "Search profile not found";
|
|
980
|
-
/** @description Human-readable explanation, typically including the unknown search profile identifier.
|
|
981
|
-
* */
|
|
980
|
+
/** @description Human-readable explanation, typically including the unknown search profile identifier. */
|
|
982
981
|
detail?: string;
|
|
983
982
|
};
|
|
984
983
|
/** @description RFC 9457 problem details for request validation errors (422). */
|
|
@@ -1054,9 +1053,11 @@ interface components {
|
|
|
1054
1053
|
};
|
|
1055
1054
|
/** @enum {string} */
|
|
1056
1055
|
CordataEnumPlaceTypeCode: "administrative" | "geographic" | "extraterrestrial";
|
|
1057
|
-
/**
|
|
1056
|
+
/**
|
|
1057
|
+
* @description A Place is a geographic entity, including geopolitical and geographic features such as cities, countries, rivers, oceans, national parks etc.
|
|
1058
1058
|
*
|
|
1059
|
-
* Currently being remodeled and will undergo changes during autumn 2023.
|
|
1059
|
+
* Currently being remodeled and will undergo changes during autumn 2023.
|
|
1060
|
+
*/
|
|
1060
1061
|
Place: {
|
|
1061
1062
|
/** @constant */
|
|
1062
1063
|
type: "Place";
|
|
@@ -1132,11 +1133,13 @@ interface components {
|
|
|
1132
1133
|
activeYears?: components["schemas"]["Year"];
|
|
1133
1134
|
/** @description Used if the person's year of birth and death is not structured enough to be used in yearOfBirth and yearOfDeath, e.g. "ca. 1200" */
|
|
1134
1135
|
unspecifiedDate?: string;
|
|
1135
|
-
/**
|
|
1136
|
+
/**
|
|
1137
|
+
* @description A nationality the author is affilated with.
|
|
1136
1138
|
*
|
|
1137
1139
|
* We register national affiliation when it is common knowledge that the person identifies as part of the group.
|
|
1138
1140
|
*
|
|
1139
|
-
* Biblioteksentralen currently registers up to two national affilations. Nations are not limited to nation states; we also register (some) stateless nationalities such as Sámi or Kurdish.
|
|
1141
|
+
* Biblioteksentralen currently registers up to two national affilations. Nations are not limited to nation states; we also register (some) stateless nationalities such as Sámi or Kurdish.
|
|
1142
|
+
*/
|
|
1140
1143
|
nationality: components["schemas"]["Nationality"][];
|
|
1141
1144
|
/** @description Internal note on the entity, e.g. the field(s) in which the person is active, if useful to differentiate them from a different person of the same name. */
|
|
1142
1145
|
scopeNote?: string;
|
|
@@ -1174,7 +1177,6 @@ interface components {
|
|
|
1174
1177
|
/**
|
|
1175
1178
|
* ArtificialAgent
|
|
1176
1179
|
* @description An Artificial Agent is an agent that is not a person or a collective of persons, for example a generative AI system credited as a contributor.
|
|
1177
|
-
*
|
|
1178
1180
|
*/
|
|
1179
1181
|
ArtificialAgent: {
|
|
1180
1182
|
/** @constant */
|
|
@@ -1235,11 +1237,13 @@ interface components {
|
|
|
1235
1237
|
nn: string;
|
|
1236
1238
|
};
|
|
1237
1239
|
};
|
|
1238
|
-
/**
|
|
1240
|
+
/**
|
|
1241
|
+
* @description A recommended age group for the audience of a work.
|
|
1239
1242
|
*
|
|
1240
1243
|
* For age limits and ratings for games and audiovisual material, see AgeLimit.
|
|
1241
1244
|
*
|
|
1242
|
-
* The age group vocabulary was developed by Biblioteksentralen and later incorporated into the Norwegian National Library's Nortarget vocabulary.
|
|
1245
|
+
* The age group vocabulary was developed by Biblioteksentralen and later incorporated into the Norwegian National Library's Nortarget vocabulary.
|
|
1246
|
+
*/
|
|
1243
1247
|
AgeGroup: components["schemas"]["CordataEnumAgeGroup"] & {
|
|
1244
1248
|
/** @description Map of other identifiers for the entity */
|
|
1245
1249
|
identifiers: {
|
|
@@ -1263,8 +1267,7 @@ interface components {
|
|
|
1263
1267
|
nn: string;
|
|
1264
1268
|
};
|
|
1265
1269
|
};
|
|
1266
|
-
/** @description Age limit or rating for games and audiovisual material, from PEGI or the Norwegian Media Authority (NMA). For recommended reading/interest age groups, see AgeGroup.
|
|
1267
|
-
* */
|
|
1270
|
+
/** @description Age limit or rating for games and audiovisual material, from PEGI or the Norwegian Media Authority (NMA). For recommended reading/interest age groups, see AgeGroup. */
|
|
1268
1271
|
AgeLimit: components["schemas"]["CordataEnumAgeLimit"] & {
|
|
1269
1272
|
/** @enum {string} */
|
|
1270
1273
|
type: "PegiAgeLimit" | "NmaAgeLimit" | "TabletopGameAgeLimit";
|
|
@@ -1272,8 +1275,7 @@ interface components {
|
|
|
1272
1275
|
years: number;
|
|
1273
1276
|
/** @description Map of other identifiers for the entity */
|
|
1274
1277
|
identifiers: {
|
|
1275
|
-
/** @description URI of the PEGI age limit from https://www.nb.no/nbvok/pegi or NMA age limit from https://www.nb.no/nbvok/nma
|
|
1276
|
-
* */
|
|
1278
|
+
/** @description URI of the PEGI age limit from https://www.nb.no/nbvok/pegi or NMA age limit from https://www.nb.no/nbvok/nma */
|
|
1277
1279
|
uri?: string;
|
|
1278
1280
|
};
|
|
1279
1281
|
};
|
|
@@ -1287,9 +1289,11 @@ interface components {
|
|
|
1287
1289
|
};
|
|
1288
1290
|
/** @enum {string} */
|
|
1289
1291
|
CordataEnumConceptTypeCode: "regular_concept" | "individual_concept" | "help_term" | "genre";
|
|
1290
|
-
/**
|
|
1292
|
+
/**
|
|
1293
|
+
* @description Concepts are one of the building blocks that make up Subjects.
|
|
1291
1294
|
* Unlike SKOS concepts, which cover anything a work can be about, Cordata Concepts are limited to concepts that do not fall under one of the more narrow categories Person, Collective Agent, Place, Genre, Work, or Individual Concept.
|
|
1292
|
-
* When a concept name is ambiguous, a clarifying specification is shown in parentheses after the name, for example "Balloons (aircraft)".
|
|
1295
|
+
* When a concept name is ambiguous, a clarifying specification is shown in parentheses after the name, for example "Balloons (aircraft)".
|
|
1296
|
+
*/
|
|
1293
1297
|
SubjectTypeConcept: components["schemas"]["SubjectBase"] & {
|
|
1294
1298
|
/** @constant */
|
|
1295
1299
|
type: "SubjectTypeConcept";
|
|
@@ -1319,10 +1323,12 @@ interface components {
|
|
|
1319
1323
|
bibbiAuthorityId?: string;
|
|
1320
1324
|
};
|
|
1321
1325
|
};
|
|
1322
|
-
/**
|
|
1326
|
+
/**
|
|
1327
|
+
* @description A Person is a subclass of Agent consisting of agents that are or purport to be individual persons.
|
|
1323
1328
|
* A group of people, known or unknown, writing under a pseudonym which is that of an individual name are treated as one person according to bibliographic convention. See for example Lars Kepler, pseudonym for Alexander Ahndoril and Alexandra Coelho Ahndoril, or Carolyn Keene, pseudonym for a number of ghost writers.
|
|
1324
1329
|
* A person who uses different names may be considered to have separate bibliographic identities if works of one type appears under one name and works of another type under another name. In such cases, a separate Person entity will be created for each bibliographic identity. The entities can be linked together with see-also relators.
|
|
1325
|
-
* Animals, fictional persons and spirits are not considered agents under the Cordata❦ framework. These are registered as Individual concepts.
|
|
1330
|
+
* Animals, fictional persons and spirits are not considered agents under the Cordata❦ framework. These are registered as Individual concepts.
|
|
1331
|
+
*/
|
|
1326
1332
|
SubjectTypePerson: components["schemas"]["SubjectBase"] & {
|
|
1327
1333
|
/** @constant */
|
|
1328
1334
|
type: "SubjectTypePerson";
|
|
@@ -1331,11 +1337,13 @@ interface components {
|
|
|
1331
1337
|
/** @description Map of identifiers for matching records in external systems. */
|
|
1332
1338
|
identifiers: components["schemas"]["AgentIdentifiers"];
|
|
1333
1339
|
};
|
|
1334
|
-
/**
|
|
1340
|
+
/**
|
|
1341
|
+
* @description A Collective Agent is defined as "A gathering or organization of persons bearing a particular name and capable of acting as a unit" (from the Library Reference Model).
|
|
1335
1342
|
*
|
|
1336
1343
|
* Examples of Collective Agents are corporations, musical or artist groups, governments, families and other organizations. A group is considered a Collective Agent if it is organized in such a way that its members can produce or approve joint statements or creations, such as when a corporation approves a report, a music group releases an album, or a government ratifies a law.
|
|
1337
1344
|
*
|
|
1338
|
-
* Movements or categories of people that are not organized such that they can speak for the whole of the group, such as for example the Black Lives Matter movement, the Preraphaelite artist movement, religious or ethnic groups, are not considered Collective Agents.
|
|
1345
|
+
* Movements or categories of people that are not organized such that they can speak for the whole of the group, such as for example the Black Lives Matter movement, the Preraphaelite artist movement, religious or ethnic groups, are not considered Collective Agents.
|
|
1346
|
+
*/
|
|
1339
1347
|
SubjectTypeCollectiveAgent: components["schemas"]["SubjectBase"] & {
|
|
1340
1348
|
/** @constant */
|
|
1341
1349
|
type: "SubjectTypeCollectiveAgent";
|
|
@@ -1366,9 +1374,11 @@ interface components {
|
|
|
1366
1374
|
neoUri?: string;
|
|
1367
1375
|
};
|
|
1368
1376
|
};
|
|
1369
|
-
/**
|
|
1377
|
+
/**
|
|
1378
|
+
* @description A Work is defined as "The intellectual or artistic content of a distinct creation" (from the Library Reference Model).
|
|
1370
1379
|
* It is the top level and most abstract entity in the WEMI stack (Work, Expression, Manifestation, Item), and serves to cluster all expressions of what one could consider "the same book" (or e.g. same play, film, game, etc.) in different formats and languages.
|
|
1371
|
-
* While the work is an abstract entity, convention is to assign it a title, language and year in order to aid with identifying the work.
|
|
1380
|
+
* While the work is an abstract entity, convention is to assign it a title, language and year in order to aid with identifying the work.
|
|
1381
|
+
*/
|
|
1372
1382
|
SubjectTypeWork: components["schemas"]["SubjectBase"] & {
|
|
1373
1383
|
/** @constant */
|
|
1374
1384
|
type: "SubjectTypeWork";
|
|
@@ -1380,23 +1390,23 @@ interface components {
|
|
|
1380
1390
|
bibbiAuthorityId?: string;
|
|
1381
1391
|
};
|
|
1382
1392
|
};
|
|
1383
|
-
/**
|
|
1384
|
-
*
|
|
1393
|
+
/**
|
|
1394
|
+
* @description A Collection is a set of entities - manifestations or works - that share certain features.
|
|
1395
|
+
* The collection can be explicitly named in the source material, such as the series "SF Masterworks" which is a collection of acclaimed SF novels published by Gollancz, or constructed from a set of features that the collected entities have in common, such as "The Lovecraft Mythos" for works that use creatures and features from H.P. Lovecraft's fictional universe.
|
|
1396
|
+
*/
|
|
1385
1397
|
SubjectTypeCollection: components["schemas"]["SubjectBase"] & {
|
|
1386
1398
|
/** @constant */
|
|
1387
1399
|
type: "SubjectTypeCollection";
|
|
1388
1400
|
/** @constant */
|
|
1389
1401
|
entityType: "collection_work";
|
|
1390
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
1391
|
-
* */
|
|
1402
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
1392
1403
|
collectionType: components["schemas"]["CordataEnumCollectionTypeCode"];
|
|
1393
1404
|
/** @description Map of identifiers for matching records in external systems. */
|
|
1394
1405
|
identifiers: {
|
|
1395
1406
|
bibbiAuthorityId?: string;
|
|
1396
1407
|
};
|
|
1397
1408
|
};
|
|
1398
|
-
/** @description Subject for a work or collection: what it is about. Discriminated by `type`.
|
|
1399
|
-
* */
|
|
1409
|
+
/** @description Subject for a work or collection: what it is about. Discriminated by `type`. */
|
|
1400
1410
|
Subject: components["schemas"]["SubjectTypeConcept"] | components["schemas"]["SubjectTypePlace"] | components["schemas"]["SubjectTypePerson"] | components["schemas"]["SubjectTypeCollectiveAgent"] | components["schemas"]["SubjectTypeEvent"] | components["schemas"]["SubjectTypeWork"] | components["schemas"]["SubjectTypeCollection"];
|
|
1401
1411
|
/** @description A language map is used to associate a language with a value in a way that allows easy programmatic access. The keys of a language map are strings representing [BCP47](https://www.rfc-editor.org/info/bcp47) language tags, defined as the shortest ISO 639 code for a language. */
|
|
1402
1412
|
LanguageMapWithEnglish: {
|
|
@@ -1413,11 +1423,13 @@ interface components {
|
|
|
1413
1423
|
uri: string;
|
|
1414
1424
|
label: components["schemas"]["LanguageMapWithEnglish"];
|
|
1415
1425
|
};
|
|
1416
|
-
/**
|
|
1426
|
+
/**
|
|
1427
|
+
* @description Genre is used to group literature and other arts into categories based on stylistic criteria.
|
|
1417
1428
|
*
|
|
1418
1429
|
* Bibliographic conventions differ as to whether to separate genre and form, as well as in what constitutes a genre and what constitures a form. The Norwegian national thesaurus for genre and form, NTSF, contains both genre and form without separation. For practical reasons, Cordata therefore includes form as a subtype of Genre, using a boolean toggle to indicate form terms.
|
|
1419
1430
|
*
|
|
1420
|
-
* Cordata currently contains genres for literature, film and games. Genres for literature and film are mapped to NTSF. Plans are to later include a genre list for music as well.
|
|
1431
|
+
* Cordata currently contains genres for literature, film and games. Genres for literature and film are mapped to NTSF. Plans are to later include a genre list for music as well.
|
|
1432
|
+
*/
|
|
1421
1433
|
Genre: {
|
|
1422
1434
|
/** @constant */
|
|
1423
1435
|
type: "Genre";
|
|
@@ -1445,8 +1457,7 @@ interface components {
|
|
|
1445
1457
|
scopeNote?: string;
|
|
1446
1458
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
1447
1459
|
};
|
|
1448
|
-
/** @description A subject in the GREP curriculum database from the Norwegian Directorate for Education and Training (Udir), linked to a work used in education. See the [GREP wiki](https://github.com/Utdanningsdirektoratet/KL06-LK20-public/wiki/).
|
|
1449
|
-
* */
|
|
1460
|
+
/** @description A subject in the GREP curriculum database from the Norwegian Directorate for Education and Training (Udir), linked to a work used in education. See the [GREP wiki](https://github.com/Utdanningsdirektoratet/KL06-LK20-public/wiki/). */
|
|
1450
1461
|
GrepSubject: {
|
|
1451
1462
|
/** @constant */
|
|
1452
1463
|
type: "GrepSubject";
|
|
@@ -1454,13 +1465,11 @@ interface components {
|
|
|
1454
1465
|
entityType: "grep";
|
|
1455
1466
|
/** @description Local identifier for the subject in BMDB. */
|
|
1456
1467
|
id: components["schemas"]["Id"];
|
|
1457
|
-
/** @description Subject code: unique identifier for the subject in the GREP database. See [fagkode](https://github.com/Utdanningsdirektoratet/KL06-LK20-public/wiki/fagkode).
|
|
1458
|
-
* */
|
|
1468
|
+
/** @description Subject code: unique identifier for the subject in the GREP database. See [fagkode](https://github.com/Utdanningsdirektoratet/KL06-LK20-public/wiki/fagkode). */
|
|
1459
1469
|
code: string;
|
|
1460
1470
|
/** @description URI of the subject in the GREP database. The URI is based on the subject code. */
|
|
1461
1471
|
uri: string;
|
|
1462
|
-
/** @description Name of the subject. Several subjects may share the same name; use `notes` to disambiguate them.
|
|
1463
|
-
* */
|
|
1472
|
+
/** @description Name of the subject. Several subjects may share the same name; use `notes` to disambiguate them. */
|
|
1464
1473
|
name: components["schemas"]["LanguageMap"];
|
|
1465
1474
|
/** @description Notes to help disambiguate the subject from other subjects with the same name. */
|
|
1466
1475
|
notes?: string;
|
|
@@ -1484,11 +1493,13 @@ interface components {
|
|
|
1484
1493
|
};
|
|
1485
1494
|
/** @enum {string} */
|
|
1486
1495
|
CordataEnumAccessibleContentCode: "ta" | "tb";
|
|
1487
|
-
/**
|
|
1496
|
+
/**
|
|
1497
|
+
* @description For accessible works, this describes the accessibility feature of the work, one of:
|
|
1488
1498
|
* - the text has been created or adapted to be easy to read (normarc 019$e code "ta", TG1006).
|
|
1489
1499
|
* - the content has been created or adapted to be easy to understand (normarc 019$e code "tb", TG1007).
|
|
1490
1500
|
*
|
|
1491
|
-
* See also the manifestation property `accessibleFormat`, which describes accessibility features which are related to format, not content, such as larger font size or dyslexia friendly fonts.
|
|
1501
|
+
* See also the manifestation property `accessibleFormat`, which describes accessibility features which are related to format, not content, such as larger font size or dyslexia friendly fonts.
|
|
1502
|
+
*/
|
|
1492
1503
|
AccessibleContentFeature: {
|
|
1493
1504
|
type: string;
|
|
1494
1505
|
code: components["schemas"]["CordataEnumAccessibleContentCode"];
|
|
@@ -1534,11 +1545,13 @@ interface components {
|
|
|
1534
1545
|
nn: string;
|
|
1535
1546
|
};
|
|
1536
1547
|
};
|
|
1537
|
-
/**
|
|
1548
|
+
/**
|
|
1549
|
+
* @description A Collection Expression expresses a CollectionWork in the same way an Expression expresses a Work.
|
|
1538
1550
|
*
|
|
1539
1551
|
* A Collection Expression contains either expressions or manifestations; this is encoded in the `domain` property. Collections on the expression level indicate that the members have shared elements which are intrinsic to the works contained, while collections on the manifestation level are often assigned by publishers and indicate thematic relations that are not intrinsic to the works but may still be interesting as a selection criterion.
|
|
1540
1552
|
*
|
|
1541
|
-
* For example, a specific manifestation of Arthur C. Clarke's work "Rendezvous with Rama" can be part of the Collection Expression "SF Masterworks", while its expression can be part of the Collection Expression "Rama". The former is at the manifestation level since it's a collection constructed by a specific publisher which does not apply to all manifestations/expressions of the work, while the latter is at the expression level since it contains expressions of works that form a continuation of a story.
|
|
1553
|
+
* For example, a specific manifestation of Arthur C. Clarke's work "Rendezvous with Rama" can be part of the Collection Expression "SF Masterworks", while its expression can be part of the Collection Expression "Rama". The former is at the manifestation level since it's a collection constructed by a specific publisher which does not apply to all manifestations/expressions of the work, while the latter is at the expression level since it contains expressions of works that form a continuation of a story.
|
|
1554
|
+
*/
|
|
1542
1555
|
BaseCollectionExpression: {
|
|
1543
1556
|
/** @constant */
|
|
1544
1557
|
type: "CollectionExpression";
|
|
@@ -1555,12 +1568,16 @@ interface components {
|
|
|
1555
1568
|
expressionType?: components["schemas"]["CordataEnumExpressionType"];
|
|
1556
1569
|
/** @description Preferred title of the Collection expression. See Title for individual components of title. */
|
|
1557
1570
|
preferredTitle: components["schemas"]["RegularTitle"];
|
|
1558
|
-
/**
|
|
1571
|
+
/**
|
|
1572
|
+
* @description Variant title of the Collection expression.
|
|
1559
1573
|
*
|
|
1560
|
-
* Recorded when a collection is known under different titles in the same language, e.g. Jenny Colgan's "Den lille øya i havet" / "Mure".
|
|
1574
|
+
* Recorded when a collection is known under different titles in the same language, e.g. Jenny Colgan's "Den lille øya i havet" / "Mure".
|
|
1575
|
+
*/
|
|
1561
1576
|
variantTitles: components["schemas"]["LegacyRegularTitle"][];
|
|
1562
|
-
/**
|
|
1563
|
-
*
|
|
1577
|
+
/**
|
|
1578
|
+
* @description Parallel title of the Collection expression.
|
|
1579
|
+
* Given when a collection is known under different titles in different languages.
|
|
1580
|
+
*/
|
|
1564
1581
|
parallelTitles: components["schemas"]["LegacyRegularTitle"][];
|
|
1565
1582
|
/** @description Whether the text has one or more translations side by side. */
|
|
1566
1583
|
hasParallelText: boolean;
|
|
@@ -1570,11 +1587,13 @@ interface components {
|
|
|
1570
1587
|
languages: components["schemas"]["Language"][];
|
|
1571
1588
|
/** @description Internal note detailing relevant information about the collection, e.g. "series numbering on spine" */
|
|
1572
1589
|
note?: string;
|
|
1573
|
-
/**
|
|
1590
|
+
/**
|
|
1591
|
+
* @description ISSN. International identifier for serials.
|
|
1574
1592
|
*
|
|
1575
1593
|
* Not all collections will have an ISSN - they are typically assigned to periodicals and certain academic serials.
|
|
1576
1594
|
*
|
|
1577
|
-
* Note that the hyphen separating the two groups of four digits is considered to be part of the ISSN, not merely an addition for readability, and stripping it may cause the ISSN to not be recognized by certain applications.
|
|
1595
|
+
* Note that the hyphen separating the two groups of four digits is considered to be part of the ISSN, not merely an addition for readability, and stripping it may cause the ISSN to not be recognized by certain applications.
|
|
1596
|
+
*/
|
|
1578
1597
|
issn?: string;
|
|
1579
1598
|
/** @description Time the Collection Expression was created. */
|
|
1580
1599
|
created?: string;
|
|
@@ -1606,15 +1625,16 @@ interface components {
|
|
|
1606
1625
|
entityType: "collection_work";
|
|
1607
1626
|
id: components["schemas"]["Id"];
|
|
1608
1627
|
identifiers: components["schemas"]["CollectionWorkIdentifiers"];
|
|
1609
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
1610
|
-
* */
|
|
1628
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
1611
1629
|
collectionType: components["schemas"]["CordataEnumCollectionTypeCode"];
|
|
1612
1630
|
workType?: components["schemas"]["CordataEnumWorkType"];
|
|
1613
1631
|
/** @description The type of literature of the collection ("skjønnlitteratur", "sakprosa", "faglitteratur"). */
|
|
1614
1632
|
literatureType?: components["schemas"]["LiteratureType"];
|
|
1615
|
-
/**
|
|
1633
|
+
/**
|
|
1634
|
+
* @description Preferred title of Collection work.
|
|
1616
1635
|
*
|
|
1617
|
-
* See Title for individual components of title.
|
|
1636
|
+
* See Title for individual components of title.
|
|
1637
|
+
*/
|
|
1618
1638
|
preferredTitle: components["schemas"]["RegularTitle"];
|
|
1619
1639
|
variantTitles?: components["schemas"]["LegacyRegularTitle"][];
|
|
1620
1640
|
/** @description List of contributors in the form of *agents* (persons or organizations) and their *roles* in the creation of the Collection. */
|
|
@@ -1631,8 +1651,7 @@ interface components {
|
|
|
1631
1651
|
/** @description Links the Collection Expression to the Collection Work it expresses. */
|
|
1632
1652
|
workExpressed?: components["schemas"]["BaseCollectionWork"];
|
|
1633
1653
|
superCollection?: components["schemas"]["BaseCollectionExpression"] & {
|
|
1634
|
-
/** @description The collection work expressed by this super-collection.
|
|
1635
|
-
* */
|
|
1654
|
+
/** @description The collection work expressed by this super-collection. */
|
|
1636
1655
|
workExpressed?: {
|
|
1637
1656
|
/** @constant */
|
|
1638
1657
|
entityType: "collection_work";
|
|
@@ -1640,14 +1659,16 @@ interface components {
|
|
|
1640
1659
|
};
|
|
1641
1660
|
};
|
|
1642
1661
|
};
|
|
1643
|
-
/**
|
|
1662
|
+
/**
|
|
1663
|
+
* @description The position of this entity in the collection/series.
|
|
1644
1664
|
*
|
|
1645
1665
|
* Currently extracted from numbering assigned to Manifestations, which may collect more than one expression.
|
|
1646
1666
|
*
|
|
1647
1667
|
* The value can take one of the following forms:
|
|
1648
1668
|
* - a single number (e.g. "1", "2"). This is the most common case.
|
|
1649
1669
|
* - a range (e.g. "1-2") that covers multiple parts of the series.
|
|
1650
|
-
* - a decimal number for cases where a single logical part has been split into multiple physical parts (e.g. "1.2" or "2022.1").
|
|
1670
|
+
* - a decimal number for cases where a single logical part has been split into multiple physical parts (e.g. "1.2" or "2022.1").
|
|
1671
|
+
*/
|
|
1651
1672
|
numberInSeries?: string;
|
|
1652
1673
|
};
|
|
1653
1674
|
CordataEnumPlatform: {
|
|
@@ -1777,9 +1798,11 @@ interface components {
|
|
|
1777
1798
|
* @enum {string}
|
|
1778
1799
|
*/
|
|
1779
1800
|
DigitalServiceId: "filmoteket" | "cineast";
|
|
1780
|
-
/**
|
|
1801
|
+
/**
|
|
1802
|
+
* @description A Manifestation is defined as "A set of all carriers that are assumed to share the same characteristics as to intellectual or artistic content and aspects of physical form. That set is defined by both the overall content and the production plan for its carrier or carriers" (from the Library Reference Model).
|
|
1781
1803
|
*
|
|
1782
|
-
* It is the third level entity in the WEMI stack (Work, Expression, Manifestation, Item), and is used to cluster all Items of the same edition.
|
|
1804
|
+
* It is the third level entity in the WEMI stack (Work, Expression, Manifestation, Item), and is used to cluster all Items of the same edition.
|
|
1805
|
+
*/
|
|
1783
1806
|
Manifestation: {
|
|
1784
1807
|
/** @constant */
|
|
1785
1808
|
type: "Manifestation";
|
|
@@ -1791,19 +1814,25 @@ interface components {
|
|
|
1791
1814
|
createDate?: string;
|
|
1792
1815
|
/** @description Time the manifestation record was last modified. */
|
|
1793
1816
|
updateDate?: string;
|
|
1794
|
-
/**
|
|
1817
|
+
/**
|
|
1818
|
+
* @description Preferred title of manifestation.
|
|
1795
1819
|
*
|
|
1796
|
-
* The preferred source of title for a manifestation is the title page. See also parallelTitles and variantTitles.
|
|
1820
|
+
* The preferred source of title for a manifestation is the title page. See also parallelTitles and variantTitles.
|
|
1821
|
+
*/
|
|
1797
1822
|
preferredTitle: components["schemas"]["RegularTitle"];
|
|
1798
|
-
/**
|
|
1823
|
+
/**
|
|
1824
|
+
* @description Parallel titles
|
|
1799
1825
|
*
|
|
1800
1826
|
* For manifestations containing two or more expressions of the same work in different languages, e.g. "As you like it = Som dere vil ha det". Bibliographic convention is to display parallel titles consecutively, separated by a = sign.
|
|
1801
1827
|
*
|
|
1802
|
-
* Each parallel title should eventually have their own `titleLanguage` value, so they can be tagged correctly for screen readers, but this is not yet implemented (as of Sept 2023).
|
|
1828
|
+
* Each parallel title should eventually have their own `titleLanguage` value, so they can be tagged correctly for screen readers, but this is not yet implemented (as of Sept 2023).
|
|
1829
|
+
*/
|
|
1803
1830
|
parallelTitles: components["schemas"]["LegacyRegularTitle"][];
|
|
1804
|
-
/**
|
|
1831
|
+
/**
|
|
1832
|
+
* @description Variant titles
|
|
1805
1833
|
*
|
|
1806
|
-
* Other title variants found on added title pages, the book cover and/or spine, that differs substantially from the main title.
|
|
1834
|
+
* Other title variants found on added title pages, the book cover and/or spine, that differs substantially from the main title.
|
|
1835
|
+
*/
|
|
1807
1836
|
variantTitles: components["schemas"]["ManifestationVariantTitle"][];
|
|
1808
1837
|
/** @description The cover image of the manifestation. */
|
|
1809
1838
|
coverImage?: string;
|
|
@@ -1811,52 +1840,63 @@ interface components {
|
|
|
1811
1840
|
binding?: components["schemas"]["CordataEnumBindingType"];
|
|
1812
1841
|
/** @description Carrier or medium of this manifestation, for example print, e-book or audio file. */
|
|
1813
1842
|
manifestationMedium: components["schemas"]["CordataEnumManifestationMedium"];
|
|
1814
|
-
/** @description Human-readable statement naming the persons or organizations responsible for the content, typically transcribed from the title page.
|
|
1815
|
-
* */
|
|
1843
|
+
/** @description Human-readable statement naming the persons or organizations responsible for the content, typically transcribed from the title page. */
|
|
1816
1844
|
statementOfResponsibility?: string;
|
|
1817
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* @description ISBN. International identifier for manifestations of books, including e-books and audio books.
|
|
1818
1847
|
*
|
|
1819
1848
|
* Intended to be unique, but is not always. A single manifestation may have more than one, or the same ISBN may erroneously be assigned to different editions of the same book or even two separate works.
|
|
1820
1849
|
*
|
|
1821
|
-
* Often styled with hyphens between the groups of numbers to aid with human-readability, but these are not an intrinsic part of the ISBN.
|
|
1850
|
+
* Often styled with hyphens between the groups of numbers to aid with human-readability, but these are not an intrinsic part of the ISBN.
|
|
1851
|
+
*/
|
|
1822
1852
|
isbn: string[];
|
|
1823
1853
|
/** @description ISBNs that are evidently incorrect for this manifestation. Typical case: the ISBN from the previous book in a series was printed on the barcode, while the ISBN intended for this book is on the title-page verso. */
|
|
1824
1854
|
incorrectIsbn: string[];
|
|
1825
|
-
/** @description ISMN. International identifier for manifestations of printed music.
|
|
1826
|
-
* */
|
|
1855
|
+
/** @description ISMN. International identifier for manifestations of printed music. */
|
|
1827
1856
|
ismn: string[];
|
|
1828
|
-
/**
|
|
1857
|
+
/**
|
|
1858
|
+
* @description EAN. Identifier for manifestations other than books and printed music.
|
|
1829
1859
|
*
|
|
1830
|
-
* In a library context, typically found on film, video games and recorded music. May occasionally be used on printed music, very rarely on books, in combination with or instead of ISMN/ISBN.
|
|
1860
|
+
* In a library context, typically found on film, video games and recorded music. May occasionally be used on printed music, very rarely on books, in combination with or instead of ISMN/ISBN.
|
|
1861
|
+
*/
|
|
1831
1862
|
ean: string[];
|
|
1832
|
-
/**
|
|
1863
|
+
/**
|
|
1864
|
+
* @description Year the manifestation was published.
|
|
1833
1865
|
*
|
|
1834
1866
|
* - The value is normally a 4-digit numeric value, but may also be a range of years.
|
|
1835
1867
|
* - An ending hyphen (-) is used for open-ended dates ("199-" means "1990-1999")
|
|
1836
1868
|
* - An ending question mark indicates that the year is uncertain ("1998?").
|
|
1837
|
-
* - The special value "ukjent år" indicates that publication year is unknown.
|
|
1869
|
+
* - The special value "ukjent år" indicates that publication year is unknown.
|
|
1870
|
+
*/
|
|
1838
1871
|
publicationYear?: string;
|
|
1839
1872
|
/** @description The publication statement lists a publisher/imprint and the associated place for that publisher. */
|
|
1840
1873
|
publicationStatements: components["schemas"]["PublicationStatement"][];
|
|
1841
1874
|
/** @description Edition */
|
|
1842
1875
|
edition?: number;
|
|
1843
|
-
/**
|
|
1844
|
-
*
|
|
1876
|
+
/**
|
|
1877
|
+
* @description Edition Statement
|
|
1878
|
+
* The edition statement is a word or phrase that indicates a difference in either content or form between different manifestations. Examples: "3rd", "Norwegian Edition", "Revised", "Definitive Edition"
|
|
1879
|
+
*/
|
|
1845
1880
|
editionStatement?: string;
|
|
1846
|
-
/** @description Agents linked to this manifestation and the role each played in producing it (for example cover designer or illustrator of this edition).
|
|
1847
|
-
* */
|
|
1881
|
+
/** @description Agents linked to this manifestation and the role each played in producing it (for example cover designer or illustrator of this edition). */
|
|
1848
1882
|
contributors: components["schemas"]["Contributor"][];
|
|
1849
|
-
/**
|
|
1883
|
+
/**
|
|
1884
|
+
* @description Subtitle languages (Språk for undertekster)
|
|
1850
1885
|
*
|
|
1851
|
-
* Languages for which subtitles are provided. Subtitles are generally designed for viewers who can hear the audio, but do not understand the spoken language, and therefore only contain a transcript of the spoken dialogue. See `captionLanguages` for subtitles designed for the deaf and hard of hearing (SDH) specifically.
|
|
1886
|
+
* Languages for which subtitles are provided. Subtitles are generally designed for viewers who can hear the audio, but do not understand the spoken language, and therefore only contain a transcript of the spoken dialogue. See `captionLanguages` for subtitles designed for the deaf and hard of hearing (SDH) specifically.
|
|
1887
|
+
*/
|
|
1852
1888
|
subtitleLanguages?: components["schemas"]["Language"][];
|
|
1853
|
-
/**
|
|
1889
|
+
/**
|
|
1890
|
+
* @description Caption languages (Språk for undertekster for hørselshemmede)
|
|
1854
1891
|
*
|
|
1855
|
-
* List of languages for which captions are provided, also known as subtitles for the deaf and hard of hearing (SDH). In addition to a transcript of the spoken dialogue, these include important non-dialogue information such as sound effects, music, and speaker identification. See also `subtitleLanguages`.
|
|
1892
|
+
* List of languages for which captions are provided, also known as subtitles for the deaf and hard of hearing (SDH). In addition to a transcript of the spoken dialogue, these include important non-dialogue information such as sound effects, music, and speaker identification. See also `subtitleLanguages`.
|
|
1893
|
+
*/
|
|
1856
1894
|
captionLanguages?: components["schemas"]["Language"][];
|
|
1857
|
-
/**
|
|
1895
|
+
/**
|
|
1896
|
+
* @description Audio description languages (Språk for synstolking)
|
|
1858
1897
|
*
|
|
1859
|
-
* List of languages for which audio descriptions are provided as an alternative mode of access to the visual content of the movie.
|
|
1898
|
+
* List of languages for which audio descriptions are provided as an alternative mode of access to the visual content of the movie.
|
|
1899
|
+
*/
|
|
1860
1900
|
audioDescriptionLanguages?: components["schemas"]["Language"][];
|
|
1861
1901
|
/** @description Number of pages. For printed books this is typically the last numbered page. */
|
|
1862
1902
|
pages?: number;
|
|
@@ -1868,36 +1908,45 @@ interface components {
|
|
|
1868
1908
|
accompanyingMaterial?: string;
|
|
1869
1909
|
/** @description Cataloguer notes about the manifestation. */
|
|
1870
1910
|
notes?: components["schemas"]["Note"][];
|
|
1871
|
-
/** @description Whether the manifestation has been approved by Arts Council Norway (Kulturrådet) for library distribution through Innkjøpsordningane for litteratur.
|
|
1872
|
-
* */
|
|
1911
|
+
/** @description Whether the manifestation has been approved by Arts Council Norway (Kulturrådet) for library distribution through Innkjøpsordningane for litteratur. */
|
|
1873
1912
|
kulturfond?: components["schemas"]["Kulturfond"];
|
|
1874
1913
|
/** @description This is an aggregate manifestation containing several works. */
|
|
1875
1914
|
isAggregateManifestation?: boolean;
|
|
1876
|
-
/**
|
|
1877
|
-
*
|
|
1915
|
+
/**
|
|
1916
|
+
* @description A list of library catalogues that include this manifestation.
|
|
1917
|
+
* Example: [{"id: "tonsberg", name: "Tønsberg og Færder" }]
|
|
1918
|
+
*/
|
|
1878
1919
|
catalogues: {
|
|
1879
1920
|
id: string;
|
|
1880
1921
|
name: string;
|
|
1881
1922
|
}[];
|
|
1882
|
-
/**
|
|
1923
|
+
/**
|
|
1924
|
+
* @description A list of library catalogue record IDs for records that correspond to this manifestation. The ID is composed of a library system prefix, the catalogue name and the local record ID in the catalogue, separated by colons.
|
|
1883
1925
|
*
|
|
1884
|
-
* Example: ["b:tonsberg:123", "q:skaun:987"]
|
|
1926
|
+
* Example: ["b:tonsberg:123", "q:skaun:987"]
|
|
1927
|
+
*/
|
|
1885
1928
|
catalogueRecords: string[];
|
|
1886
|
-
/**
|
|
1887
|
-
*
|
|
1929
|
+
/**
|
|
1930
|
+
* @description A list of digital services that include this manifestation.
|
|
1931
|
+
* Example: [{"id: "filmoteket", name: "Filmoteket" }]
|
|
1932
|
+
*/
|
|
1888
1933
|
digitalServices: {
|
|
1889
1934
|
id: components["schemas"]["DigitalServiceId"];
|
|
1890
1935
|
name: string;
|
|
1891
1936
|
}[];
|
|
1892
|
-
/**
|
|
1937
|
+
/**
|
|
1938
|
+
* @description A list of digital service record IDs for records that correspond to this manifestation. The ID is composed of the digital service name and the local record ID in the service, separated by colons.
|
|
1893
1939
|
*
|
|
1894
|
-
* Example: ["filmoteket:123", "cineast:987"]
|
|
1940
|
+
* Example: ["filmoteket:123", "cineast:987"]
|
|
1941
|
+
*/
|
|
1895
1942
|
digitalServiceRecords: string[];
|
|
1896
1943
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
1897
1944
|
};
|
|
1898
|
-
/**
|
|
1945
|
+
/**
|
|
1946
|
+
* @description An Expression is defined as "A distinct combination of signs conveying intellectual or artistic content" (from the Library Reference Model).
|
|
1899
1947
|
*
|
|
1900
|
-
* It is the second level entity in the WEMI stack (Work, Expression, Manifestation, Item), and serves to group Manifestations of the same language and type - that is to say all manifestations using the same semiotic signs to convey the content.
|
|
1948
|
+
* It is the second level entity in the WEMI stack (Work, Expression, Manifestation, Item), and serves to group Manifestations of the same language and type - that is to say all manifestations using the same semiotic signs to convey the content.
|
|
1949
|
+
*/
|
|
1901
1950
|
Expression: {
|
|
1902
1951
|
/** @constant */
|
|
1903
1952
|
type: "Expression";
|
|
@@ -1907,17 +1956,17 @@ interface components {
|
|
|
1907
1956
|
identifiers?: components["schemas"]["ExpressionIdentifiers"];
|
|
1908
1957
|
/** @description Preferred title of expression. See Title for individual components of title. */
|
|
1909
1958
|
preferredTitle: components["schemas"]["RegularTitle"];
|
|
1910
|
-
/** @description Variant titles of the expression in the same language as the preferred title, recorded when the expression is known under more than one title.
|
|
1911
|
-
* */
|
|
1959
|
+
/** @description Variant titles of the expression in the same language as the preferred title, recorded when the expression is known under more than one title. */
|
|
1912
1960
|
variantTitles?: components["schemas"]["LegacyRegularTitle"][];
|
|
1913
|
-
/** @description Parallel titles of the expression in other languages, typically when the same expression carries titles in more than one language.
|
|
1914
|
-
* */
|
|
1961
|
+
/** @description Parallel titles of the expression in other languages, typically when the same expression carries titles in more than one language. */
|
|
1915
1962
|
parallelTitles?: components["schemas"]["LegacyRegularTitle"][];
|
|
1916
1963
|
/** @description A list of contributors in the form of Agents and their Roles in the creation of the Expression. */
|
|
1917
1964
|
contributors: components["schemas"]["Contributor"][];
|
|
1918
|
-
/**
|
|
1965
|
+
/**
|
|
1966
|
+
* @description The language(s) of the expression.
|
|
1919
1967
|
*
|
|
1920
|
-
* In the case of video games, spoken language is registered in this field, and text languages are registered as `gameTextLanguages`.
|
|
1968
|
+
* In the case of video games, spoken language is registered in this field, and text languages are registered as `gameTextLanguages`.
|
|
1969
|
+
*/
|
|
1921
1970
|
languages: components["schemas"]["Language"][];
|
|
1922
1971
|
/** @description Whether the text has one or more translations side by side. */
|
|
1923
1972
|
hasParallelText: boolean;
|
|
@@ -1930,9 +1979,11 @@ interface components {
|
|
|
1930
1979
|
edition?: string;
|
|
1931
1980
|
/** @description List of collections the Expression is part of, in the form of Collection Expression entries. */
|
|
1932
1981
|
collections: components["schemas"]["ExpressionCollectionExpressionEntry"][];
|
|
1933
|
-
/**
|
|
1982
|
+
/**
|
|
1983
|
+
* @description For video games, this lists the gaming platform(s) that this expression of the game has been released for and thus are optimized for. Games may still be playable on newer platforms through backwards compatibility.
|
|
1934
1984
|
*
|
|
1935
|
-
* The list is usually single-valued since platform is a distinguishing characteristic for expressions. The exception is when a game is released to support two generations of gaming consoles through an optional platform upgrade, such as a PlayStation 4 game that can be upgraded for PlayStation 5.
|
|
1985
|
+
* The list is usually single-valued since platform is a distinguishing characteristic for expressions. The exception is when a game is released to support two generations of gaming consoles through an optional platform upgrade, such as a PlayStation 4 game that can be upgraded for PlayStation 5.
|
|
1986
|
+
*/
|
|
1936
1987
|
platforms?: components["schemas"]["Platform"][];
|
|
1937
1988
|
/** @description List of alternatives for instrumentation of a music work. Each instrumentation is a set of instruments and optionally number of performers on the instrument. */
|
|
1938
1989
|
instrumentations?: components["schemas"]["Instrumentation"][];
|
|
@@ -1945,8 +1996,7 @@ interface components {
|
|
|
1945
1996
|
};
|
|
1946
1997
|
/** @description Manifestations of this expression. */
|
|
1947
1998
|
manifestations: components["schemas"]["Manifestation"][];
|
|
1948
|
-
/** @description Aggregate manifestations that contain this expression together with other works (for example an anthology).
|
|
1949
|
-
* */
|
|
1999
|
+
/** @description Aggregate manifestations that contain this expression together with other works (for example an anthology). */
|
|
1950
2000
|
aggregateManifestations: components["schemas"]["Manifestation"][];
|
|
1951
2001
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
1952
2002
|
};
|
|
@@ -1959,7 +2009,8 @@ interface components {
|
|
|
1959
2009
|
} & components["schemas"]["BaseWork"] & {
|
|
1960
2010
|
workType: components["schemas"]["CordataEnumWorkType"];
|
|
1961
2011
|
literatureType?: components["schemas"]["LiteratureType"];
|
|
1962
|
-
/**
|
|
2012
|
+
/**
|
|
2013
|
+
* @description Preferred title of work.
|
|
1963
2014
|
*
|
|
1964
2015
|
* Typically this will be the title the work was assigned at its first publication or release. Exceptions are made if:
|
|
1965
2016
|
* - the work is significantly more well known under a later or abbreviated form of the title; e.g. *"Hamlet"*, not *"The tragedy of Hamlet, prince of Denmark"*.
|
|
@@ -1968,29 +2019,36 @@ interface components {
|
|
|
1968
2019
|
*
|
|
1969
2020
|
* For works where the first publication has two main titles separated by "or" (subsequent main title), only the first title is registered as the preferred title for the work, e.g. *"The hobbit"*, not *"The hobbit, or, There and back again"*.
|
|
1970
2021
|
*
|
|
1971
|
-
* Classical music works without titles in the traditional sense will instead get a generic uniform title, synthesized from key information about the work, such as "Symphonies, no. 6, op. 6, F major". In these cases, the title is of type UniformTitleMusic.
|
|
2022
|
+
* Classical music works without titles in the traditional sense will instead get a generic uniform title, synthesized from key information about the work, such as "Symphonies, no. 6, op. 6, F major". In these cases, the title is of type UniformTitleMusic.
|
|
2023
|
+
*/
|
|
1972
2024
|
preferredTitle: components["schemas"]["RegularTitle"] | components["schemas"]["UniformTitleMusic"];
|
|
1973
|
-
/**
|
|
2025
|
+
/**
|
|
2026
|
+
* @description Variant titles which aid in identifying a manifestation as belonging to a work.
|
|
1974
2027
|
*
|
|
1975
2028
|
* Variant titles are typically registered if:
|
|
1976
2029
|
* - there is more than one title in the original language of the work, e.g. "The golden compass" for "Northern lights" / Philip Pullman.
|
|
1977
2030
|
* - there are established longer or shorter forms of the title, e.g. "The tragedy of Hamlet, prince of Denmark" for "Hamlet".
|
|
1978
2031
|
* - The uniform title differs from the title in the original language, e.g. "Alf laylah wa-laylah" for "Tusen og en natt".
|
|
1979
2032
|
*
|
|
1980
|
-
* See Title for individual components of title.
|
|
2033
|
+
* See Title for individual components of title.
|
|
2034
|
+
*/
|
|
1981
2035
|
variantTitles: components["schemas"]["LegacyRegularTitle"][];
|
|
1982
2036
|
/** @description The languages of the representative expression of the work. */
|
|
1983
2037
|
languages: components["schemas"]["Language"][];
|
|
1984
|
-
/**
|
|
2038
|
+
/**
|
|
2039
|
+
* @description List of contributors to the *work* in the form of *agents* (persons or organizations) and their *roles* in the creation of the work.
|
|
1985
2040
|
*
|
|
1986
|
-
* Work contributors include authors for books, editors for edited works, composers for music, directors and screenwriters for films, etc., but not contributors that played a role in the creation of a specific expression (e.g. translators, illustrators, etc.) or manifestation (e.g. illustrators, cover designers, etc.).
|
|
2041
|
+
* Work contributors include authors for books, editors for edited works, composers for music, directors and screenwriters for films, etc., but not contributors that played a role in the creation of a specific expression (e.g. translators, illustrators, etc.) or manifestation (e.g. illustrators, cover designers, etc.).
|
|
2042
|
+
*/
|
|
1987
2043
|
contributors: components["schemas"]["Contributor"][];
|
|
1988
2044
|
illustrations?: components["schemas"]["CordataEnumWorkIllustrationsOption"];
|
|
1989
|
-
/**
|
|
2045
|
+
/**
|
|
2046
|
+
* @description The recommended age group(s) for the work as assigned by Biblioteksentralen according to a controlled vocabulary.
|
|
1990
2047
|
*
|
|
1991
2048
|
* Typically, multiple consecutive age groups are assigned to a work, e.g. "mu" (13-16) and "vu" (16-18) for young adult fiction, or "vu" (16-18) and "v" (Adults) for fiction suited for older teens and adults.
|
|
1992
2049
|
*
|
|
1993
|
-
* Both fiction and non-fiction are assigned age groups based on interest level; Biblioteksentralen does not assign reading level age groups.
|
|
2050
|
+
* Both fiction and non-fiction are assigned age groups based on interest level; Biblioteksentralen does not assign reading level age groups.
|
|
2051
|
+
*/
|
|
1994
2052
|
ageGroups: components["schemas"]["AgeGroup"][];
|
|
1995
2053
|
ageLimit?: components["schemas"]["AgeLimit"];
|
|
1996
2054
|
/** @description Plot summary or other descriptive text of the work, when available. */
|
|
@@ -1999,8 +2057,7 @@ interface components {
|
|
|
1999
2057
|
subjects: components["schemas"]["Subject"][];
|
|
2000
2058
|
/** @description Genres and form terms. Form terms have `isForm: true`. */
|
|
2001
2059
|
genres: components["schemas"]["Genre"][];
|
|
2002
|
-
/** @description GREP curriculum subjects from the Norwegian Directorate for Education and Training (Udir), linked to a work used in education.
|
|
2003
|
-
* */
|
|
2060
|
+
/** @description GREP curriculum subjects from the Norwegian Directorate for Education and Training (Udir), linked to a work used in education. */
|
|
2004
2061
|
grepSubjects?: components["schemas"]["GrepSubject"][];
|
|
2005
2062
|
/** @description Whether the work has been created or adapted for users with special needs. */
|
|
2006
2063
|
accessibleContentFeature?: components["schemas"]["AccessibleContentFeature"];
|
|
@@ -2024,13 +2081,11 @@ interface components {
|
|
|
2024
2081
|
* @description The classification scheme. 'ddk5' refers to the old Norwegian version of Dewey Decimal
|
|
2025
2082
|
* Classification that was deprecated around ????, while 'webdewey' refers to the web-based
|
|
2026
2083
|
* version of Dewey Decimal Classification that is currently in use, also known as DDC 23.
|
|
2027
|
-
*
|
|
2028
2084
|
* @enum {string}
|
|
2029
2085
|
*/
|
|
2030
2086
|
scheme: "webdewey" | "ddk5";
|
|
2031
2087
|
};
|
|
2032
|
-
/** @description Expressions of this work, each with their manifestations.
|
|
2033
|
-
* */
|
|
2088
|
+
/** @description Expressions of this work, each with their manifestations. */
|
|
2034
2089
|
expressions: components["schemas"]["Expression"][];
|
|
2035
2090
|
};
|
|
2036
2091
|
/** @description Full `Work` records for the requested IDs. */
|
|
@@ -2043,15 +2098,13 @@ interface components {
|
|
|
2043
2098
|
/** @description A batch of full `Work` records from a harvest. `resumptionToken` is present when more remain. */
|
|
2044
2099
|
HarvestWorks200Response: {
|
|
2045
2100
|
results: components["schemas"]["Work"][];
|
|
2046
|
-
/** @description Present when more records remain. Repeat the request with this token to fetch the next batch. Omitted on the last page.
|
|
2047
|
-
* */
|
|
2101
|
+
/** @description Present when more records remain. Repeat the request with this token to fetch the next batch. Omitted on the last page. */
|
|
2048
2102
|
resumptionToken?: string;
|
|
2049
2103
|
};
|
|
2050
2104
|
/** @description A batch of work IDs from a harvest. `resumptionToken` is present when more remain. */
|
|
2051
2105
|
HarvestWorkIds200Response: {
|
|
2052
2106
|
results: string[];
|
|
2053
|
-
/** @description Present when more records remain. Repeat the request with this token to fetch the next batch. Omitted on the last page.
|
|
2054
|
-
* */
|
|
2107
|
+
/** @description Present when more records remain. Repeat the request with this token to fetch the next batch. Omitted on the last page. */
|
|
2055
2108
|
resumptionToken?: string;
|
|
2056
2109
|
};
|
|
2057
2110
|
AgentSearchFilterType: {
|
|
@@ -2093,7 +2146,6 @@ interface components {
|
|
|
2093
2146
|
/**
|
|
2094
2147
|
* AgentSummary
|
|
2095
2148
|
* @description Compact agent record returned by agent search. Fetch `GET /{searchProfile}/agents` for the full Person, CollectiveAgent or ArtificialAgent.
|
|
2096
|
-
*
|
|
2097
2149
|
*/
|
|
2098
2150
|
AgentSummary: components["schemas"]["AgentSummaryBase"] & {
|
|
2099
2151
|
/** @constant */
|
|
@@ -2155,8 +2207,7 @@ interface components {
|
|
|
2155
2207
|
* @enum {string}
|
|
2156
2208
|
*/
|
|
2157
2209
|
CollectionSearchFacetType: "catalogue" | "creator";
|
|
2158
|
-
/** @description Compact collection record returned by collection search. A collection is a set of works that share features, such as a named book series or a constructed grouping. Fetch `GET /{searchProfile}/collections` for the full collection work and its expressions.
|
|
2159
|
-
* */
|
|
2210
|
+
/** @description Compact collection record returned by collection search. A collection is a set of works that share features, such as a named book series or a constructed grouping. Fetch `GET /{searchProfile}/collections` for the full collection work and its expressions. */
|
|
2160
2211
|
CollectionSummary: {
|
|
2161
2212
|
/** @constant */
|
|
2162
2213
|
type: "CollectionSummary";
|
|
@@ -2164,18 +2215,18 @@ interface components {
|
|
|
2164
2215
|
entityType: "collection_work";
|
|
2165
2216
|
id: components["schemas"]["Id"];
|
|
2166
2217
|
identifiers: components["schemas"]["CollectionWorkIdentifiers"];
|
|
2167
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
2168
|
-
* */
|
|
2218
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
2169
2219
|
collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
|
|
2170
2220
|
workType?: components["schemas"]["CordataEnumWorkTypeTranslated"];
|
|
2171
2221
|
expressionType?: components["schemas"]["CordataEnumExpressionTypeTranslated"];
|
|
2172
2222
|
literatureType?: components["schemas"]["LiteratureTypeTranslated"];
|
|
2173
|
-
/**
|
|
2223
|
+
/**
|
|
2224
|
+
* @description Preferred title of Collection work.
|
|
2174
2225
|
*
|
|
2175
|
-
* See Title for individual components of title.
|
|
2226
|
+
* See Title for individual components of title.
|
|
2227
|
+
*/
|
|
2176
2228
|
preferredTitle: components["schemas"]["TitleSummary"];
|
|
2177
|
-
/** @description Languages of the collection's expressions. Each inner array is the language set of one collection expression.
|
|
2178
|
-
* */
|
|
2229
|
+
/** @description Languages of the collection's expressions. Each inner array is the language set of one collection expression. */
|
|
2179
2230
|
languages: components["schemas"]["Language"][][];
|
|
2180
2231
|
forms?: {
|
|
2181
2232
|
/** @constant */
|
|
@@ -2217,12 +2268,13 @@ interface components {
|
|
|
2217
2268
|
/** @constant */
|
|
2218
2269
|
entityType: "collection_work";
|
|
2219
2270
|
id: string;
|
|
2220
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
2221
|
-
* */
|
|
2271
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
2222
2272
|
collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
|
|
2223
|
-
/**
|
|
2273
|
+
/**
|
|
2274
|
+
* @description Preferred title of Collection work.
|
|
2224
2275
|
*
|
|
2225
|
-
* See Title for individual components of title.
|
|
2276
|
+
* See Title for individual components of title.
|
|
2277
|
+
*/
|
|
2226
2278
|
preferredTitle: components["schemas"]["TitleSummary"];
|
|
2227
2279
|
};
|
|
2228
2280
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
@@ -2249,19 +2301,22 @@ interface components {
|
|
|
2249
2301
|
/**
|
|
2250
2302
|
* CollectionWork
|
|
2251
2303
|
* @description Full collection record returned by get-by-ID. Includes collection expressions and an optional super-collection (for nested series).
|
|
2252
|
-
*
|
|
2253
2304
|
*/
|
|
2254
2305
|
CollectionWork: components["schemas"]["BaseCollectionWork"] & {
|
|
2255
|
-
/**
|
|
2306
|
+
/**
|
|
2307
|
+
* @description Links the collection to an overarching collection.
|
|
2256
2308
|
*
|
|
2257
|
-
* An example where this is used is the series "Warriors" ("Kattekrigerne") by Erin Hunter. This series contains a number of subseries such as "7. The Broken Code", which in turn contains a number of books such as "5. The Place of No Stars".
|
|
2309
|
+
* An example where this is used is the series "Warriors" ("Kattekrigerne") by Erin Hunter. This series contains a number of subseries such as "7. The Broken Code", which in turn contains a number of books such as "5. The Place of No Stars".
|
|
2310
|
+
*/
|
|
2258
2311
|
superCollection?: components["schemas"]["BaseCollectionWork"];
|
|
2259
2312
|
/** CollectionExpression */
|
|
2260
2313
|
collectionExpressions: (components["schemas"]["BaseCollectionExpression"] & {
|
|
2261
2314
|
/** @description Image URLs associated with this collection expression, typically cover images. */
|
|
2262
2315
|
images: string[];
|
|
2263
|
-
/**
|
|
2264
|
-
*
|
|
2316
|
+
/**
|
|
2317
|
+
* @description A list of library catalogues that include this collection expression.
|
|
2318
|
+
* Example: [{"id: "tonsberg", name: "Tønsberg og Færder" }]
|
|
2319
|
+
*/
|
|
2265
2320
|
catalogues: {
|
|
2266
2321
|
id: string;
|
|
2267
2322
|
name: string;
|
|
@@ -2319,8 +2374,7 @@ interface components {
|
|
|
2319
2374
|
code: components["schemas"]["CordataEnumPlaceTypeCode"];
|
|
2320
2375
|
label: string;
|
|
2321
2376
|
};
|
|
2322
|
-
/** @description Compact subject returned by subject search. `name` is the display label. `about` is the entity the subject refers to. Fetch `GET /{searchProfile}/subjects` for the full `Subject`.
|
|
2323
|
-
* */
|
|
2377
|
+
/** @description Compact subject returned by subject search. `name` is the display label. `about` is the entity the subject refers to. Fetch `GET /{searchProfile}/subjects` for the full `Subject`. */
|
|
2324
2378
|
SubjectSummary: {
|
|
2325
2379
|
id: components["schemas"]["Id"];
|
|
2326
2380
|
/** @description Display name of the subject. */
|
|
@@ -2329,8 +2383,7 @@ interface components {
|
|
|
2329
2383
|
type: "SubjectSummary";
|
|
2330
2384
|
/** @constant */
|
|
2331
2385
|
entityType: "subject";
|
|
2332
|
-
/** @description The entity this subject concerns: a concept, event, place, agent, work or collection.
|
|
2333
|
-
* */
|
|
2386
|
+
/** @description The entity this subject concerns: a concept, event, place, agent, work or collection. */
|
|
2334
2387
|
about?: {
|
|
2335
2388
|
/** @constant */
|
|
2336
2389
|
type: "SubjectSummaryConcept";
|
|
@@ -2385,8 +2438,7 @@ interface components {
|
|
|
2385
2438
|
type: "SubjectSummaryCollection";
|
|
2386
2439
|
/** @constant */
|
|
2387
2440
|
entityType: "collection_work";
|
|
2388
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
2389
|
-
* */
|
|
2441
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
2390
2442
|
collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
|
|
2391
2443
|
identifiers: components["schemas"]["CollectionWorkIdentifiers"];
|
|
2392
2444
|
};
|
|
@@ -2417,8 +2469,7 @@ interface components {
|
|
|
2417
2469
|
subject: components["schemas"]["Subject"];
|
|
2418
2470
|
}[];
|
|
2419
2471
|
};
|
|
2420
|
-
/** @description Compact work attached to a catalogue record: the work the record embodies (1-1), or a work contained (1-N) in an aggregate manifestation.
|
|
2421
|
-
* */
|
|
2472
|
+
/** @description Compact work attached to a catalogue record: the work the record embodies (1-1), or a work contained (1-N) in an aggregate manifestation. */
|
|
2422
2473
|
CatalogueRecordWork: {
|
|
2423
2474
|
/** @constant */
|
|
2424
2475
|
type: "CatalogueRecordWork";
|
|
@@ -2458,20 +2509,24 @@ interface components {
|
|
|
2458
2509
|
}[];
|
|
2459
2510
|
isUnstable: components["schemas"]["IsUnstable"];
|
|
2460
2511
|
};
|
|
2461
|
-
/**
|
|
2512
|
+
/**
|
|
2513
|
+
* @description A library catalogue record expressed as the Cordata work, expression and manifestation it has been matched to.
|
|
2462
2514
|
* `id` is the local library-system record ID (or a BMDB manifestation ID when using search profile `global`). `work` is the work the record embodies (1-1). Aggregate manifestations also list other contained works (1-N) in `containedWorks` (for example the individual short stories in a collection).
|
|
2463
|
-
|
|
2515
|
+
*/
|
|
2464
2516
|
CatalogueRecord: {
|
|
2465
2517
|
/** @constant */
|
|
2466
2518
|
type: "CatalogueRecord";
|
|
2467
|
-
/**
|
|
2468
|
-
*
|
|
2519
|
+
/**
|
|
2520
|
+
* @description Identifier for the catalogue record in the library system. Whether the catalogue ID prefix is included depends on whether it was used in the input query `ids`. If not the ID is not globally unique, but unique within the library system.
|
|
2521
|
+
* The exception is when using the `global` search profile, in which case the ID is also the globally unique `manifestationId` from BMDB.
|
|
2522
|
+
*/
|
|
2469
2523
|
id: string;
|
|
2470
2524
|
work: components["schemas"]["CatalogueRecordWork"];
|
|
2471
|
-
/**
|
|
2525
|
+
/**
|
|
2526
|
+
* @description Additional works that this manifestation *contains* (1-N), besides the work it *embodies* (1-1) on `work`.
|
|
2472
2527
|
*
|
|
2473
2528
|
* For a short-story collection, for example, the short stories themselves are works contained in the manifestation, while the collection also constitute its own work embodied by the manifestation. Empty or omitted when the manifestation embodies a single work.
|
|
2474
|
-
|
|
2529
|
+
*/
|
|
2475
2530
|
containedWorks?: components["schemas"]["CatalogueRecordWork"][];
|
|
2476
2531
|
expression: {
|
|
2477
2532
|
/** @constant */
|
|
@@ -2521,14 +2576,11 @@ interface components {
|
|
|
2521
2576
|
is_unstable?: boolean;
|
|
2522
2577
|
};
|
|
2523
2578
|
EntitySuggestionBase: {
|
|
2524
|
-
/** @description A unique key for the suggestion. Cannot be used as an ID elsewhere in the API, but can be used to distinguish between suggestions, for example in a suggestion list.
|
|
2525
|
-
* */
|
|
2579
|
+
/** @description A unique key for the suggestion. Cannot be used as an ID elsewhere in the API, but can be used to distinguish between suggestions, for example in a suggestion list. */
|
|
2526
2580
|
key: string;
|
|
2527
|
-
/** @description BMDB ID of the entity this suggestion represents.
|
|
2528
|
-
* */
|
|
2581
|
+
/** @description BMDB ID of the entity this suggestion represents. */
|
|
2529
2582
|
entityId: components["schemas"]["Id"];
|
|
2530
|
-
/** @description The text that is suggested for the user. Can be displayed in a suggestion list. Can be used to perform a search, if the intention is not to filter other entites (see `filters`) or link to the one represented by this suggestion (see `entityId`).
|
|
2531
|
-
* */
|
|
2583
|
+
/** @description The text that is suggested for the user. Can be displayed in a suggestion list. Can be used to perform a search, if the intention is not to filter other entites (see `filters`) or link to the one represented by this suggestion (see `entityId`). */
|
|
2532
2584
|
suggestedText: string;
|
|
2533
2585
|
};
|
|
2534
2586
|
SuggestionAgentBase: {
|
|
@@ -2550,33 +2602,28 @@ interface components {
|
|
|
2550
2602
|
roles: components["schemas"]["CordataEnumContributorRoleTranslated"][];
|
|
2551
2603
|
};
|
|
2552
2604
|
EntitySuggestionFilter: {
|
|
2553
|
-
/** @description Filter parameter name when applying this suggestion, as in `?filter[key]=value`.
|
|
2554
|
-
* */
|
|
2605
|
+
/** @description Filter parameter name when applying this suggestion, as in `?filter[key]=value`. */
|
|
2555
2606
|
key: string;
|
|
2556
|
-
/** @description Filter parameter value when applying this suggestion, as in `?filter[key]=value`.
|
|
2557
|
-
* */
|
|
2607
|
+
/** @description Filter parameter value when applying this suggestion, as in `?filter[key]=value`. */
|
|
2558
2608
|
value: string;
|
|
2559
|
-
/** @description Human-readable name for the filter.
|
|
2560
|
-
* */
|
|
2609
|
+
/** @description Human-readable name for the filter. */
|
|
2561
2610
|
label: string;
|
|
2562
2611
|
};
|
|
2563
2612
|
NonEntitySuggestionBase: {
|
|
2564
|
-
/** @description A unique key for the suggestion. Cannot be used as an ID elsewhere in the API, but can be used to distinguish between suggestions, for example in a suggestion list.
|
|
2565
|
-
* */
|
|
2613
|
+
/** @description A unique key for the suggestion. Cannot be used as an ID elsewhere in the API, but can be used to distinguish between suggestions, for example in a suggestion list. */
|
|
2566
2614
|
key: string;
|
|
2567
|
-
/** @description The text that is suggested for the user. Can be displayed in a suggestion list. Can be used to perform a search, if the intention is not to filter other entites (see `filters`).
|
|
2568
|
-
* */
|
|
2615
|
+
/** @description The text that is suggested for the user. Can be displayed in a suggestion list. Can be used to perform a search, if the intention is not to filter other entites (see `filters`). */
|
|
2569
2616
|
suggestedText: string;
|
|
2570
2617
|
};
|
|
2571
2618
|
NonEntitySuggestionFilter: components["schemas"]["EntitySuggestionFilter"] & {
|
|
2572
|
-
/**
|
|
2619
|
+
/**
|
|
2620
|
+
* @description Advanced-search query string that can filter entities. Use as `?query=...`.
|
|
2573
2621
|
*
|
|
2574
2622
|
* Example: `creator:"Firstname Lastname"`.
|
|
2575
|
-
|
|
2623
|
+
*/
|
|
2576
2624
|
query: string;
|
|
2577
2625
|
};
|
|
2578
|
-
/** @description Compact search-as-you-type hit. Discriminated by `type`: `WorkSuggestion`, `AgentSuggestion`, `CollectionSuggestion` or `SubjectSuggestion`. `suggestedText` is the string to show the user. Agent and subject suggestions include `filters` for a follow-up work or collection filter search.
|
|
2579
|
-
* */
|
|
2626
|
+
/** @description Compact search-as-you-type hit. Discriminated by `type`: `WorkSuggestion`, `AgentSuggestion`, `CollectionSuggestion` or `SubjectSuggestion`. `suggestedText` is the string to show the user. Agent and subject suggestions include `filters` for a follow-up work or collection filter search. */
|
|
2580
2627
|
Suggestion: (components["schemas"]["EntitySuggestionBase"] & {
|
|
2581
2628
|
/** @constant */
|
|
2582
2629
|
type: "WorkEntitySuggestion";
|
|
@@ -2604,8 +2651,7 @@ interface components {
|
|
|
2604
2651
|
type: "CollectionEntitySuggestion";
|
|
2605
2652
|
/** @constant */
|
|
2606
2653
|
entityType: "collection_work";
|
|
2607
|
-
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games).
|
|
2608
|
-
* */
|
|
2654
|
+
/** @description Kind of collection: `series` (named series), `fictional_universe` (shared fictional setting or mythos), `multipart_work` (a work issued in several parts), or `game_family` (related games). */
|
|
2609
2655
|
collectionType: components["schemas"]["CordataEnumCollectionTypeTranslated"];
|
|
2610
2656
|
workType?: components["schemas"]["CordataEnumWorkTypeTranslated"];
|
|
2611
2657
|
expressionTypes?: components["schemas"]["CordataEnumExpressionTypeTranslated"][];
|
|
@@ -2631,8 +2677,7 @@ interface components {
|
|
|
2631
2677
|
label: string;
|
|
2632
2678
|
};
|
|
2633
2679
|
});
|
|
2634
|
-
/** @description Search-as-you-type suggestions. Each hit is a `Suggestion`.
|
|
2635
|
-
* */
|
|
2680
|
+
/** @description Search-as-you-type suggestions. Each hit is a `Suggestion`. */
|
|
2636
2681
|
SearchSuggestions200Response: {
|
|
2637
2682
|
results: {
|
|
2638
2683
|
suggestion: components["schemas"]["Suggestion"];
|
|
@@ -2671,8 +2716,7 @@ interface components {
|
|
|
2671
2716
|
oaiPmhSet?: string;
|
|
2672
2717
|
librarySystem: components["schemas"]["LibrarySystem"];
|
|
2673
2718
|
};
|
|
2674
|
-
/** @description Scopes Cordata endpoints to a library's catalogues and configured digital services. The `global` profile has no catalogue restriction.
|
|
2675
|
-
* */
|
|
2719
|
+
/** @description Scopes Cordata endpoints to a library's catalogues and configured digital services. The `global` profile has no catalogue restriction. */
|
|
2676
2720
|
SearchProfile: {
|
|
2677
2721
|
/** @description Search profile identifier, used as `{searchProfile}` in other routes. */
|
|
2678
2722
|
id: string;
|
|
@@ -2706,54 +2750,50 @@ interface components {
|
|
|
2706
2750
|
};
|
|
2707
2751
|
};
|
|
2708
2752
|
parameters: {
|
|
2709
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
2710
|
-
* */
|
|
2753
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
2711
2754
|
FeatureFlagParameter: "noop"[];
|
|
2712
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
2713
2757
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
2714
|
-
|
|
2758
|
+
*/
|
|
2715
2759
|
UiLanguageParameter: "nb" | "nn";
|
|
2716
2760
|
/**
|
|
2717
2761
|
* @description Free-text search query. When omitted, results are still returned using the endpoint's
|
|
2718
2762
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
2719
2763
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
2720
2764
|
* lists the problems.
|
|
2721
|
-
*
|
|
2722
2765
|
* @example bølgene
|
|
2723
2766
|
*/
|
|
2724
2767
|
QueryParameter: string;
|
|
2725
|
-
/** @description Comma-separated IDs to fetch.
|
|
2726
|
-
* */
|
|
2768
|
+
/** @description Comma-separated IDs to fetch. */
|
|
2727
2769
|
IdsParameter: string;
|
|
2728
|
-
/**
|
|
2770
|
+
/**
|
|
2771
|
+
* @description Page number, starting at 1 (default 1).
|
|
2729
2772
|
* Use a harvest endpoint for larger result sets.
|
|
2730
|
-
|
|
2773
|
+
*/
|
|
2731
2774
|
PageParameter: number;
|
|
2732
|
-
/**
|
|
2775
|
+
/**
|
|
2776
|
+
* @description Page size (default 10, maximum 100).
|
|
2733
2777
|
* Use a harvest endpoint for larger result sets.
|
|
2734
|
-
|
|
2778
|
+
*/
|
|
2735
2779
|
SizeParameter: number;
|
|
2736
|
-
/** @description Number of terms to return for each requested facet (default 10, maximum 500).
|
|
2737
|
-
* */
|
|
2780
|
+
/** @description Number of terms to return for each requested facet (default 10, maximum 500). */
|
|
2738
2781
|
FacetTermsSizeParameter: number;
|
|
2739
2782
|
/**
|
|
2740
2783
|
* @description Inclusive start of the harvest window. ISO 8601 datetime with UTC offset
|
|
2741
2784
|
* (for example `2024-01-01T00:00:00Z`). Cannot be combined with `resumptionToken`.
|
|
2742
|
-
*
|
|
2743
2785
|
* @example 2024-01-01T00:00:00Z
|
|
2744
2786
|
*/
|
|
2745
2787
|
HarvestFromParameter: string;
|
|
2746
2788
|
/**
|
|
2747
2789
|
* @description Opaque token from a previous harvest response. Repeat the request with this token
|
|
2748
2790
|
* to fetch the next batch. Cannot be combined with `from`.
|
|
2749
|
-
*
|
|
2750
2791
|
* @example eyJzZWFyY2hBZnRlciI6WyIyMDI0LTAxLTAyVDAwOjAwOjAwLjAwMFoiXX0
|
|
2751
2792
|
*/
|
|
2752
2793
|
ResumptionTokenParameter: string;
|
|
2753
2794
|
/**
|
|
2754
2795
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
2755
2796
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
2756
|
-
*
|
|
2757
2797
|
* @example global
|
|
2758
2798
|
*/
|
|
2759
2799
|
SearchProfileParameter: string;
|
|
@@ -2771,17 +2811,18 @@ interface operations {
|
|
|
2771
2811
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
2772
2812
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
2773
2813
|
* lists the problems.
|
|
2774
|
-
*
|
|
2775
2814
|
* @example bølgene
|
|
2776
2815
|
*/
|
|
2777
2816
|
query?: components["parameters"]["QueryParameter"];
|
|
2778
|
-
/**
|
|
2817
|
+
/**
|
|
2818
|
+
* @description Page size (default 10, maximum 100).
|
|
2779
2819
|
* Use a harvest endpoint for larger result sets.
|
|
2780
|
-
|
|
2820
|
+
*/
|
|
2781
2821
|
size?: components["parameters"]["SizeParameter"];
|
|
2782
|
-
/**
|
|
2822
|
+
/**
|
|
2823
|
+
* @description Page number, starting at 1 (default 1).
|
|
2783
2824
|
* Use a harvest endpoint for larger result sets.
|
|
2784
|
-
|
|
2825
|
+
*/
|
|
2785
2826
|
page?: components["parameters"]["PageParameter"];
|
|
2786
2827
|
/**
|
|
2787
2828
|
* @description Deep-object filters (`filter[work_type]=LiteraryWork`). All supplied filters are
|
|
@@ -2796,7 +2837,6 @@ interface operations {
|
|
|
2796
2837
|
* `is_not_short_work`, `is_aggregating_work`) use `true` or `false`.
|
|
2797
2838
|
* `age_range` uses `from:to` (either bound may be omitted), for example `6:12` or `:16`.
|
|
2798
2839
|
* `contributor_with_role` uses `{agentId}/role={roleCode}`.
|
|
2799
|
-
*
|
|
2800
2840
|
* @example {
|
|
2801
2841
|
* "literature_type": "skjønnlitteratur",
|
|
2802
2842
|
* "language": "nob"
|
|
@@ -2806,28 +2846,25 @@ interface operations {
|
|
|
2806
2846
|
/**
|
|
2807
2847
|
* @description Sort order. Defaults to `relevance.desc` when `query` is set, otherwise
|
|
2808
2848
|
* `publicationDate.desc`.
|
|
2809
|
-
*
|
|
2810
2849
|
* @example relevance.desc
|
|
2811
2850
|
*/
|
|
2812
2851
|
sort?: components["schemas"]["WorkSearchSortType"];
|
|
2813
2852
|
/**
|
|
2814
2853
|
* @description Facet types to include in the response. Comma-separated.
|
|
2815
|
-
*
|
|
2816
2854
|
* @example [
|
|
2817
2855
|
* "work_type",
|
|
2818
2856
|
* "genre"
|
|
2819
2857
|
* ]
|
|
2820
2858
|
*/
|
|
2821
2859
|
facet?: components["schemas"]["WorkSearchFacetType"][];
|
|
2822
|
-
/** @description Number of terms to return for each requested facet (default 10, maximum 500).
|
|
2823
|
-
* */
|
|
2860
|
+
/** @description Number of terms to return for each requested facet (default 10, maximum 500). */
|
|
2824
2861
|
facet_terms_size?: components["parameters"]["FacetTermsSizeParameter"];
|
|
2825
|
-
/**
|
|
2862
|
+
/**
|
|
2863
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
2826
2864
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
2827
|
-
|
|
2865
|
+
*/
|
|
2828
2866
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
2829
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
2830
|
-
* */
|
|
2867
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
2831
2868
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
2832
2869
|
};
|
|
2833
2870
|
header?: never;
|
|
@@ -2835,7 +2872,6 @@ interface operations {
|
|
|
2835
2872
|
/**
|
|
2836
2873
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
2837
2874
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
2838
|
-
*
|
|
2839
2875
|
* @example global
|
|
2840
2876
|
*/
|
|
2841
2877
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -2877,15 +2913,14 @@ interface operations {
|
|
|
2877
2913
|
getWorks: {
|
|
2878
2914
|
parameters: {
|
|
2879
2915
|
query: {
|
|
2880
|
-
/** @description Comma-separated IDs to fetch.
|
|
2881
|
-
* */
|
|
2916
|
+
/** @description Comma-separated IDs to fetch. */
|
|
2882
2917
|
ids: components["parameters"]["IdsParameter"];
|
|
2883
|
-
/**
|
|
2918
|
+
/**
|
|
2919
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
2884
2920
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
2885
|
-
|
|
2921
|
+
*/
|
|
2886
2922
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
2887
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
2888
|
-
* */
|
|
2923
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
2889
2924
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
2890
2925
|
};
|
|
2891
2926
|
header?: never;
|
|
@@ -2893,7 +2928,6 @@ interface operations {
|
|
|
2893
2928
|
/**
|
|
2894
2929
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
2895
2930
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
2896
|
-
*
|
|
2897
2931
|
* @example global
|
|
2898
2932
|
*/
|
|
2899
2933
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -2935,26 +2969,24 @@ interface operations {
|
|
|
2935
2969
|
harvestWorks: {
|
|
2936
2970
|
parameters: {
|
|
2937
2971
|
query?: {
|
|
2938
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
2939
|
-
* */
|
|
2972
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
2940
2973
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
2941
2974
|
/**
|
|
2942
2975
|
* @description Inclusive start of the harvest window. ISO 8601 datetime with UTC offset
|
|
2943
2976
|
* (for example `2024-01-01T00:00:00Z`). Cannot be combined with `resumptionToken`.
|
|
2944
|
-
*
|
|
2945
2977
|
* @example 2024-01-01T00:00:00Z
|
|
2946
2978
|
*/
|
|
2947
2979
|
from?: components["parameters"]["HarvestFromParameter"];
|
|
2948
2980
|
/**
|
|
2949
2981
|
* @description Opaque token from a previous harvest response. Repeat the request with this token
|
|
2950
2982
|
* to fetch the next batch. Cannot be combined with `from`.
|
|
2951
|
-
*
|
|
2952
2983
|
* @example eyJzZWFyY2hBZnRlciI6WyIyMDI0LTAxLTAyVDAwOjAwOjAwLjAwMFoiXX0
|
|
2953
2984
|
*/
|
|
2954
2985
|
resumptionToken?: components["parameters"]["ResumptionTokenParameter"];
|
|
2955
|
-
/**
|
|
2986
|
+
/**
|
|
2987
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
2956
2988
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
2957
|
-
|
|
2989
|
+
*/
|
|
2958
2990
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
2959
2991
|
};
|
|
2960
2992
|
header?: never;
|
|
@@ -2962,7 +2994,6 @@ interface operations {
|
|
|
2962
2994
|
/**
|
|
2963
2995
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
2964
2996
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
2965
|
-
*
|
|
2966
2997
|
* @example global
|
|
2967
2998
|
*/
|
|
2968
2999
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3011,26 +3042,24 @@ interface operations {
|
|
|
3011
3042
|
harvestWorkIds: {
|
|
3012
3043
|
parameters: {
|
|
3013
3044
|
query?: {
|
|
3014
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3015
|
-
* */
|
|
3045
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3016
3046
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3017
3047
|
/**
|
|
3018
3048
|
* @description Inclusive start of the harvest window. ISO 8601 datetime with UTC offset
|
|
3019
3049
|
* (for example `2024-01-01T00:00:00Z`). Cannot be combined with `resumptionToken`.
|
|
3020
|
-
*
|
|
3021
3050
|
* @example 2024-01-01T00:00:00Z
|
|
3022
3051
|
*/
|
|
3023
3052
|
from?: components["parameters"]["HarvestFromParameter"];
|
|
3024
3053
|
/**
|
|
3025
3054
|
* @description Opaque token from a previous harvest response. Repeat the request with this token
|
|
3026
3055
|
* to fetch the next batch. Cannot be combined with `from`.
|
|
3027
|
-
*
|
|
3028
3056
|
* @example eyJzZWFyY2hBZnRlciI6WyIyMDI0LTAxLTAyVDAwOjAwOjAwLjAwMFoiXX0
|
|
3029
3057
|
*/
|
|
3030
3058
|
resumptionToken?: components["parameters"]["ResumptionTokenParameter"];
|
|
3031
|
-
/**
|
|
3059
|
+
/**
|
|
3060
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3032
3061
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3033
|
-
|
|
3062
|
+
*/
|
|
3034
3063
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3035
3064
|
};
|
|
3036
3065
|
header?: never;
|
|
@@ -3038,7 +3067,6 @@ interface operations {
|
|
|
3038
3067
|
/**
|
|
3039
3068
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3040
3069
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3041
|
-
*
|
|
3042
3070
|
* @example global
|
|
3043
3071
|
*/
|
|
3044
3072
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3092,39 +3120,40 @@ interface operations {
|
|
|
3092
3120
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
3093
3121
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
3094
3122
|
* lists the problems.
|
|
3095
|
-
*
|
|
3096
3123
|
* @example bølgene
|
|
3097
3124
|
*/
|
|
3098
3125
|
query?: components["parameters"]["QueryParameter"];
|
|
3099
|
-
/**
|
|
3126
|
+
/**
|
|
3127
|
+
* @description Page size (default 10, maximum 100).
|
|
3100
3128
|
* Use a harvest endpoint for larger result sets.
|
|
3101
|
-
|
|
3129
|
+
*/
|
|
3102
3130
|
size?: components["parameters"]["SizeParameter"];
|
|
3103
|
-
/**
|
|
3131
|
+
/**
|
|
3132
|
+
* @description Page number, starting at 1 (default 1).
|
|
3104
3133
|
* Use a harvest endpoint for larger result sets.
|
|
3105
|
-
|
|
3134
|
+
*/
|
|
3106
3135
|
page?: components["parameters"]["PageParameter"];
|
|
3107
|
-
/**
|
|
3136
|
+
/**
|
|
3137
|
+
* @description Deep-object filters (`filter[nationality]=n`). All supplied filters are AND'ed
|
|
3108
3138
|
* together. All filters except `catalogue` accept multiple comma-separated values
|
|
3109
3139
|
* that are OR'ed together.
|
|
3110
|
-
|
|
3140
|
+
*/
|
|
3111
3141
|
filter?: components["schemas"]["AgentSearchFilterType"];
|
|
3112
|
-
/**
|
|
3142
|
+
/**
|
|
3143
|
+
* @description Sort order. Defaults to `relevance.desc` when `query` is set, otherwise
|
|
3113
3144
|
* `updateTime.desc`.
|
|
3114
|
-
|
|
3145
|
+
*/
|
|
3115
3146
|
sort?: components["schemas"]["AgentSearchSortType"];
|
|
3116
|
-
/** @description Facet types to include in the response. Comma-separated.
|
|
3117
|
-
* */
|
|
3147
|
+
/** @description Facet types to include in the response. Comma-separated. */
|
|
3118
3148
|
facet?: components["schemas"]["AgentSearchFacetType"][];
|
|
3119
|
-
/** @description Number of terms to return for each requested facet (default 10, maximum 500).
|
|
3120
|
-
* */
|
|
3149
|
+
/** @description Number of terms to return for each requested facet (default 10, maximum 500). */
|
|
3121
3150
|
facet_terms_size?: components["parameters"]["FacetTermsSizeParameter"];
|
|
3122
|
-
/**
|
|
3151
|
+
/**
|
|
3152
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3123
3153
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3124
|
-
|
|
3154
|
+
*/
|
|
3125
3155
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3126
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3127
|
-
* */
|
|
3156
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3128
3157
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3129
3158
|
};
|
|
3130
3159
|
header?: never;
|
|
@@ -3132,7 +3161,6 @@ interface operations {
|
|
|
3132
3161
|
/**
|
|
3133
3162
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3134
3163
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3135
|
-
*
|
|
3136
3164
|
* @example global
|
|
3137
3165
|
*/
|
|
3138
3166
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3174,12 +3202,12 @@ interface operations {
|
|
|
3174
3202
|
getAgents: {
|
|
3175
3203
|
parameters: {
|
|
3176
3204
|
query: {
|
|
3177
|
-
/** @description Comma-separated IDs to fetch.
|
|
3178
|
-
* */
|
|
3205
|
+
/** @description Comma-separated IDs to fetch. */
|
|
3179
3206
|
ids: components["parameters"]["IdsParameter"];
|
|
3180
|
-
/**
|
|
3207
|
+
/**
|
|
3208
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3181
3209
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3182
|
-
|
|
3210
|
+
*/
|
|
3183
3211
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3184
3212
|
};
|
|
3185
3213
|
header?: never;
|
|
@@ -3187,7 +3215,6 @@ interface operations {
|
|
|
3187
3215
|
/**
|
|
3188
3216
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3189
3217
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3190
|
-
*
|
|
3191
3218
|
* @example global
|
|
3192
3219
|
*/
|
|
3193
3220
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3234,39 +3261,40 @@ interface operations {
|
|
|
3234
3261
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
3235
3262
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
3236
3263
|
* lists the problems.
|
|
3237
|
-
*
|
|
3238
3264
|
* @example bølgene
|
|
3239
3265
|
*/
|
|
3240
3266
|
query?: components["parameters"]["QueryParameter"];
|
|
3241
|
-
/**
|
|
3267
|
+
/**
|
|
3268
|
+
* @description Page size (default 10, maximum 100).
|
|
3242
3269
|
* Use a harvest endpoint for larger result sets.
|
|
3243
|
-
|
|
3270
|
+
*/
|
|
3244
3271
|
size?: components["parameters"]["SizeParameter"];
|
|
3245
|
-
/**
|
|
3272
|
+
/**
|
|
3273
|
+
* @description Page number, starting at 1 (default 1).
|
|
3246
3274
|
* Use a harvest endpoint for larger result sets.
|
|
3247
|
-
|
|
3275
|
+
*/
|
|
3248
3276
|
page?: components["parameters"]["PageParameter"];
|
|
3249
|
-
/**
|
|
3277
|
+
/**
|
|
3278
|
+
* @description Deep-object filters (`filter[collection_type]=series`). All supplied filters are
|
|
3250
3279
|
* AND'ed together. All filters except `catalogue` accept multiple comma-separated
|
|
3251
3280
|
* values that are OR'ed together.
|
|
3252
|
-
|
|
3281
|
+
*/
|
|
3253
3282
|
filter?: components["schemas"]["CollectionSearchFilterType"];
|
|
3254
|
-
/**
|
|
3283
|
+
/**
|
|
3284
|
+
* @description Sort order. Defaults to `relevance.desc` when `query` is set, otherwise
|
|
3255
3285
|
* `updateTime.desc`.
|
|
3256
|
-
|
|
3286
|
+
*/
|
|
3257
3287
|
sort?: components["schemas"]["CollectionSearchSortType"];
|
|
3258
|
-
/** @description Facet types to include in the response. Comma-separated.
|
|
3259
|
-
* */
|
|
3288
|
+
/** @description Facet types to include in the response. Comma-separated. */
|
|
3260
3289
|
facet?: components["schemas"]["CollectionSearchFacetType"][];
|
|
3261
|
-
/** @description Number of terms to return for each requested facet (default 10, maximum 500).
|
|
3262
|
-
* */
|
|
3290
|
+
/** @description Number of terms to return for each requested facet (default 10, maximum 500). */
|
|
3263
3291
|
facet_terms_size?: components["parameters"]["FacetTermsSizeParameter"];
|
|
3264
|
-
/**
|
|
3292
|
+
/**
|
|
3293
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3265
3294
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3266
|
-
|
|
3295
|
+
*/
|
|
3267
3296
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3268
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3269
|
-
* */
|
|
3297
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3270
3298
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3271
3299
|
};
|
|
3272
3300
|
header?: never;
|
|
@@ -3274,7 +3302,6 @@ interface operations {
|
|
|
3274
3302
|
/**
|
|
3275
3303
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3276
3304
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3277
|
-
*
|
|
3278
3305
|
* @example global
|
|
3279
3306
|
*/
|
|
3280
3307
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3316,12 +3343,12 @@ interface operations {
|
|
|
3316
3343
|
getCollections: {
|
|
3317
3344
|
parameters: {
|
|
3318
3345
|
query: {
|
|
3319
|
-
/** @description Comma-separated IDs to fetch.
|
|
3320
|
-
* */
|
|
3346
|
+
/** @description Comma-separated IDs to fetch. */
|
|
3321
3347
|
ids: components["parameters"]["IdsParameter"];
|
|
3322
|
-
/**
|
|
3348
|
+
/**
|
|
3349
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3323
3350
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3324
|
-
|
|
3351
|
+
*/
|
|
3325
3352
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3326
3353
|
};
|
|
3327
3354
|
header?: never;
|
|
@@ -3329,7 +3356,6 @@ interface operations {
|
|
|
3329
3356
|
/**
|
|
3330
3357
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3331
3358
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3332
|
-
*
|
|
3333
3359
|
* @example global
|
|
3334
3360
|
*/
|
|
3335
3361
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3376,39 +3402,40 @@ interface operations {
|
|
|
3376
3402
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
3377
3403
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
3378
3404
|
* lists the problems.
|
|
3379
|
-
*
|
|
3380
3405
|
* @example bølgene
|
|
3381
3406
|
*/
|
|
3382
3407
|
query?: components["parameters"]["QueryParameter"];
|
|
3383
|
-
/**
|
|
3408
|
+
/**
|
|
3409
|
+
* @description Page size (default 10, maximum 100).
|
|
3384
3410
|
* Use a harvest endpoint for larger result sets.
|
|
3385
|
-
|
|
3411
|
+
*/
|
|
3386
3412
|
size?: components["parameters"]["SizeParameter"];
|
|
3387
|
-
/**
|
|
3413
|
+
/**
|
|
3414
|
+
* @description Page number, starting at 1 (default 1).
|
|
3388
3415
|
* Use a harvest endpoint for larger result sets.
|
|
3389
|
-
|
|
3416
|
+
*/
|
|
3390
3417
|
page?: components["parameters"]["PageParameter"];
|
|
3391
|
-
/**
|
|
3418
|
+
/**
|
|
3419
|
+
* @description Deep-object filters (`filter[type]=concept`). All supplied filters are AND'ed
|
|
3392
3420
|
* together. All filters except `catalogue` accept multiple comma-separated values
|
|
3393
3421
|
* that are OR'ed together.
|
|
3394
|
-
|
|
3422
|
+
*/
|
|
3395
3423
|
filter?: components["schemas"]["SubjectSearchFilterType"];
|
|
3396
|
-
/**
|
|
3424
|
+
/**
|
|
3425
|
+
* @description Sort order. Defaults to `relevance.desc` when `query` is set, otherwise
|
|
3397
3426
|
* `updateTime.desc`.
|
|
3398
|
-
|
|
3427
|
+
*/
|
|
3399
3428
|
sort?: components["schemas"]["SubjectSearchSortType"];
|
|
3400
|
-
/** @description Facet types to include in the response. Comma-separated.
|
|
3401
|
-
* */
|
|
3429
|
+
/** @description Facet types to include in the response. Comma-separated. */
|
|
3402
3430
|
facet?: components["schemas"]["SubjectSearchFacetType"][];
|
|
3403
|
-
/** @description Number of terms to return for each requested facet (default 10, maximum 500).
|
|
3404
|
-
* */
|
|
3431
|
+
/** @description Number of terms to return for each requested facet (default 10, maximum 500). */
|
|
3405
3432
|
facet_terms_size?: components["parameters"]["FacetTermsSizeParameter"];
|
|
3406
|
-
/**
|
|
3433
|
+
/**
|
|
3434
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3407
3435
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3408
|
-
|
|
3436
|
+
*/
|
|
3409
3437
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3410
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3411
|
-
* */
|
|
3438
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3412
3439
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3413
3440
|
};
|
|
3414
3441
|
header?: never;
|
|
@@ -3416,7 +3443,6 @@ interface operations {
|
|
|
3416
3443
|
/**
|
|
3417
3444
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3418
3445
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3419
|
-
*
|
|
3420
3446
|
* @example global
|
|
3421
3447
|
*/
|
|
3422
3448
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3458,12 +3484,12 @@ interface operations {
|
|
|
3458
3484
|
getSubjects: {
|
|
3459
3485
|
parameters: {
|
|
3460
3486
|
query: {
|
|
3461
|
-
/** @description Comma-separated IDs to fetch.
|
|
3462
|
-
* */
|
|
3487
|
+
/** @description Comma-separated IDs to fetch. */
|
|
3463
3488
|
ids: components["parameters"]["IdsParameter"];
|
|
3464
|
-
/**
|
|
3489
|
+
/**
|
|
3490
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3465
3491
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3466
|
-
|
|
3492
|
+
*/
|
|
3467
3493
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3468
3494
|
};
|
|
3469
3495
|
header?: never;
|
|
@@ -3471,7 +3497,6 @@ interface operations {
|
|
|
3471
3497
|
/**
|
|
3472
3498
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3473
3499
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3474
|
-
*
|
|
3475
3500
|
* @example global
|
|
3476
3501
|
*/
|
|
3477
3502
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3513,15 +3538,14 @@ interface operations {
|
|
|
3513
3538
|
getCatalogueRecords: {
|
|
3514
3539
|
parameters: {
|
|
3515
3540
|
query: {
|
|
3516
|
-
/** @description Comma-separated IDs to fetch.
|
|
3517
|
-
* */
|
|
3541
|
+
/** @description Comma-separated IDs to fetch. */
|
|
3518
3542
|
ids: components["parameters"]["IdsParameter"];
|
|
3519
|
-
/**
|
|
3543
|
+
/**
|
|
3544
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3520
3545
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3521
|
-
|
|
3546
|
+
*/
|
|
3522
3547
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3523
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3524
|
-
* */
|
|
3548
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3525
3549
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3526
3550
|
};
|
|
3527
3551
|
header?: never;
|
|
@@ -3529,7 +3553,6 @@ interface operations {
|
|
|
3529
3553
|
/**
|
|
3530
3554
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3531
3555
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3532
|
-
*
|
|
3533
3556
|
* @example global
|
|
3534
3557
|
*/
|
|
3535
3558
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3576,25 +3599,26 @@ interface operations {
|
|
|
3576
3599
|
* default sort. Phrase and advanced query syntax are supported; if an advanced query
|
|
3577
3600
|
* cannot be parsed, the request falls back to a standard search and `advancedQueryErrors`
|
|
3578
3601
|
* lists the problems.
|
|
3579
|
-
*
|
|
3580
3602
|
* @example bølgene
|
|
3581
3603
|
*/
|
|
3582
3604
|
query?: components["parameters"]["QueryParameter"];
|
|
3583
|
-
/**
|
|
3605
|
+
/**
|
|
3606
|
+
* @description Page size (default 10, maximum 100).
|
|
3584
3607
|
* Use a harvest endpoint for larger result sets.
|
|
3585
|
-
|
|
3608
|
+
*/
|
|
3586
3609
|
size?: components["parameters"]["SizeParameter"];
|
|
3587
|
-
/**
|
|
3610
|
+
/**
|
|
3611
|
+
* @description Deep-object filters. All supplied filters are AND'ed together.
|
|
3588
3612
|
* `entity_type` accepts multiple comma-separated values that are OR'ed together
|
|
3589
3613
|
* (`work`, `agent`, `collection`, `subject`).
|
|
3590
|
-
|
|
3614
|
+
*/
|
|
3591
3615
|
filter?: components["schemas"]["SuggestionSearchFilterType"];
|
|
3592
|
-
/**
|
|
3616
|
+
/**
|
|
3617
|
+
* @description Language of human-readable labels in the response (`nb` Bokmål, `nn` Nynorsk).
|
|
3593
3618
|
* Codes, IDs and structure are unaffected. Defaults to `nb`.
|
|
3594
|
-
|
|
3619
|
+
*/
|
|
3595
3620
|
ui_language?: components["parameters"]["UiLanguageParameter"];
|
|
3596
|
-
/** @description Experimental feature flags. May be removed without notice.
|
|
3597
|
-
* */
|
|
3621
|
+
/** @description Experimental feature flags. May be removed without notice. */
|
|
3598
3622
|
ft?: components["parameters"]["FeatureFlagParameter"];
|
|
3599
3623
|
};
|
|
3600
3624
|
header?: never;
|
|
@@ -3602,7 +3626,6 @@ interface operations {
|
|
|
3602
3626
|
/**
|
|
3603
3627
|
* @description Search profile that scopes results to a library's catalogues and digital services.
|
|
3604
3628
|
* Use `global` to search across all libraries. List profiles with `GET /search-profiles`.
|
|
3605
|
-
*
|
|
3606
3629
|
* @example global
|
|
3607
3630
|
*/
|
|
3608
3631
|
searchProfile: components["parameters"]["SearchProfileParameter"];
|
|
@@ -3646,7 +3669,6 @@ interface operations {
|
|
|
3646
3669
|
query?: {
|
|
3647
3670
|
/**
|
|
3648
3671
|
* @description Comma-separated search profile IDs. Omit to return all profiles.
|
|
3649
|
-
*
|
|
3650
3672
|
* @example global
|
|
3651
3673
|
*/
|
|
3652
3674
|
ids?: string;
|
|
@@ -4127,7 +4149,7 @@ declare const cordataEnumExpressionTypeMap: {
|
|
|
4127
4149
|
};
|
|
4128
4150
|
readonly comments: null;
|
|
4129
4151
|
readonly domain: "cordata";
|
|
4130
|
-
readonly work_type: "
|
|
4152
|
+
readonly work_type: "tabletop_game";
|
|
4131
4153
|
readonly preferred_name_definite: {
|
|
4132
4154
|
readonly nb: "brettspillet";
|
|
4133
4155
|
readonly nn: "brettspillet";
|
|
@@ -8014,7 +8036,7 @@ declare const cordataEnumLanguageMap: {
|
|
|
8014
8036
|
readonly nn: "tuareg";
|
|
8015
8037
|
readonly en: "Tuareg";
|
|
8016
8038
|
};
|
|
8017
|
-
readonly comments:
|
|
8039
|
+
readonly comments: 'Brukes om alle tuaregspråk/-dialekter. Merk at ISO 639 bruker navnet "Tamashek", ikke "Tuareg", om språket med kode "tmh". I Glottolog er "Tamashek" imidlertid skilt ut som et underspråk: <https://glottolog.org/resource/languoid/id/tama1365>. I <https://en.wikipedia.org/w/index.php?title=Tamasheq_language&oldid=1216564415> er det en disambigueringsnote "For the macrolanguage sometimes called Tamasheq, see Tuareg languages".Vi antar at "tmh" i ISO 639, som er klassifisert som makrospråk, er ment å dekke tuaregspråk som helhet, ikke ikke kun dialekten "Tamashek".';
|
|
8018
8040
|
readonly domain: "cordata";
|
|
8019
8041
|
readonly iso639_2b: "tmh";
|
|
8020
8042
|
readonly iso639_3: "tmh";
|
|
@@ -8276,7 +8298,7 @@ declare const cordataEnumContributorRoleMap: {
|
|
|
8276
8298
|
readonly normarc_code: "forf.";
|
|
8277
8299
|
readonly bibframe_code: null;
|
|
8278
8300
|
readonly rda_code: null;
|
|
8279
|
-
readonly entities: ["work"];
|
|
8301
|
+
readonly entities: ["expression", "work"];
|
|
8280
8302
|
readonly type: "contributor_role";
|
|
8281
8303
|
};
|
|
8282
8304
|
readonly translator: {
|
|
@@ -8327,7 +8349,7 @@ declare const cordataEnumContributorRoleMap: {
|
|
|
8327
8349
|
readonly normarc_code: "medarb.";
|
|
8328
8350
|
readonly bibframe_code: null;
|
|
8329
8351
|
readonly rda_code: null;
|
|
8330
|
-
readonly entities: ["
|
|
8352
|
+
readonly entities: ["expression", "manifestation", "work"];
|
|
8331
8353
|
readonly type: "contributor_role";
|
|
8332
8354
|
};
|
|
8333
8355
|
readonly reteller: {
|
|
@@ -8548,7 +8570,7 @@ declare const cordataEnumContributorRoleMap: {
|
|
|
8548
8570
|
readonly normarc_code: "illustr.";
|
|
8549
8571
|
readonly bibframe_code: null;
|
|
8550
8572
|
readonly rda_code: null;
|
|
8551
|
-
readonly entities: ["
|
|
8573
|
+
readonly entities: ["expression", "manifestation"];
|
|
8552
8574
|
readonly type: "contributor_role";
|
|
8553
8575
|
};
|
|
8554
8576
|
readonly instrumentalist: {
|
|
@@ -8786,7 +8808,7 @@ declare const cordataEnumContributorRoleMap: {
|
|
|
8786
8808
|
readonly normarc_code: "medarb.";
|
|
8787
8809
|
readonly bibframe_code: null;
|
|
8788
8810
|
readonly rda_code: null;
|
|
8789
|
-
readonly entities: ["
|
|
8811
|
+
readonly entities: ["expression", "manifestation"];
|
|
8790
8812
|
readonly type: "contributor_role";
|
|
8791
8813
|
};
|
|
8792
8814
|
readonly musician: {
|
|
@@ -8888,7 +8910,7 @@ declare const cordataEnumContributorRoleMap: {
|
|
|
8888
8910
|
readonly normarc_code: "red.";
|
|
8889
8911
|
readonly bibframe_code: null;
|
|
8890
8912
|
readonly rda_code: null;
|
|
8891
|
-
readonly entities: ["
|
|
8913
|
+
readonly entities: ["expression", "manifestation", "work"];
|
|
8892
8914
|
readonly type: "contributor_role";
|
|
8893
8915
|
};
|
|
8894
8916
|
readonly director: {
|
|
@@ -9113,4 +9135,4 @@ type BmdbSearchClient = Client<BmdbCordataApiV1Paths>;
|
|
|
9113
9135
|
declare const createBmdbFetchClient: (options: BmdbSearchClientOptions) => BmdbSearchClient;
|
|
9114
9136
|
//#endregion
|
|
9115
9137
|
export { parseCatalogueId as C, ParsedCatalogueId as S, serializeDigitalServiceRecordId as _, BmdbCordataApiV1Schemas as a, parseCatalogueRecordId as b, isCordataEnumContributorRoleCode as c, isCordataEnumManifestationMediumCode as d, isCordataEnumWorkTypeCode as f, parseDigitalServiceRecordId as g, ParsedDigitalServiceRecordId as h, BmdbCordataApiV1Paths as i, isCordataEnumExpressionTypeCode as l, DigitalServiceRecordId as m, BmdbSearchClientOptions as n, isCordataEnumAgeGroupCode as o, formatIsbdTitle as p, createBmdbFetchClient as r, isCordataEnumAgeLimitCode as s, BmdbSearchClient as t, isCordataEnumLanguageCode as u, CatalogueRecordId as v, serializeCatalogueId as w, serializeCatalogueRecordId as x, ParsedCatalogueRecordId as y };
|
|
9116
|
-
//# sourceMappingURL=index-
|
|
9138
|
+
//# sourceMappingURL=index-CVJjkWB5.d.ts.map
|