Datensätze

export interface AvailableDatasets {
    /**
     * Die Liste der Datensätze.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * Die ID des Datensatzes.
     */
    id: string;

    /**
     * Der Name des Datensatzes.
     */
    name: string;

    /**
     * Die Website zum Datensatz.
     */
    website: string;

    /**
     * Die URL, unter der die Lizenz für den Datensatz gefunden werden kann.
     */
    licenseUrl: string;

    /**
     * Der englische Name für den Datensatz.
     */
    englishName: string;

    /**
     * Die ISO 639 3-Buchstaben-Sprachkennzeichnung, in der der Datensatz hauptsächlich vorliegt.
     */
    language: string;

    /**
     * Die Richtung, in der die Sprache geschrieben ist.
     * „ltr“ bedeutet, dass der Text von links nach rechts geschrieben wird.
     * „rtl“ bedeutet, dass der Text von rechts nach links geschrieben wird.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Der API-Link zur Liste der für diesen Datensatz verfügbaren Bücher.
     */
    listOfBooksApiLink: string;

    /**
     * Die Liste der verfügbaren Formate.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Die Anzahl der in diesem Datensatz enthaltenen Bücher.
     */
    numberOfBooks: number;

    /**
     * Die Gesamtzahl der Kapitel, die in diesem Datensatz enthalten sind.
     */
    totalNumberOfChapters: number;

    /**
     * Die Gesamtzahl der Verse, die in diesem Datensatz enthalten sind.
     */
    totalNumberOfVerses: number;

    /**
     * Die Gesamtzahl der Querverweise in diesem Datensatz.
     */
    totalNumberOfReferences: number;

    /**
     * Gibt den Namen der Sprache zurück, in der der Datensatz vorliegt.
     * Null oder undefiniert, wenn der Name der Sprache nicht bekannt ist.
     */
    languageName?: string;

    /**
     * Gibt den Namen der Sprache auf Englisch zurück.
     * Null oder undefiniert, wenn die Sprache keinen englischen Namen hat.
     */
    languageEnglishName?: string;

    /**
     * Die API-Links für die Listen der Entitäten im Datensatz.
     * Wird weggelassen, wenn der Datensatz die entsprechenden Entitäten nicht enthält.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Die Gesamtzahl der im Datensatz enthaltenen Entitäten.
     * Wird weggelassen, wenn der Datensatz die entsprechenden Entitäten nicht enthält.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Die Datensatzinformationen für die Bücher.
     */
    dataset: Dataset;

    /**
     * Die Liste der für den Datensatz verfügbaren Bücher.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * Die ID des Buches.
     * Entspricht der ID des entsprechenden Buches in der Bibel (GEN, EXO usw.).
     */
    id: string;

    /**
     * Die Reihenfolge der Bücher in der Bibel.
     */
    order: number;

    /**
     * Die Nummer des ersten Kapitels im Buch.
     */
    firstChapterNumber: number;

    /**
     * Der Link zum ersten Kapitel des Buches.
     */
    firstChapterApiLink: string | null;

    /**
     * Die Nummer des letzten Kapitels im Buch.
     */
    lastChapterNumber: number | null;

    /**
     * Der Link zum letzten Kapitel des Buches.
     */
    lastChapterApiLink: string | null;

    /**
     * Die Anzahl der Kapitel, die das Buch enthält.
     */
    numberOfChapters: number;

    /**
     * Die Anzahl der Verse, die das Buch enthält.
     */
    totalNumberOfVerses: number;

    /**
     * Die Gesamtzahl der Querverweise in diesem Buch.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Die Datensatzinformationen für das Buchkapitel.
     */
    dataset: Dataset;

    /**
     * Die Buchinformationen für das Buchkapitel.
     */
    book: DatasetBook;

    /**
     * Der Link zu diesem Kapitel.
     */
    thisChapterLink: string;

    /**
     * Der Link zum nächsten Kapitel.
     * Null, falls dies das letzte Kapitel im Datensatz ist.
     */
    nextChapterApiLink: string | null;

    /**
     * Der Link zum vorherigen Kapitel.
     * Null, falls dies das erste Kapitel im Datensatz ist.
     */
    previousChapterApiLink: string | null;

    /**
     * Die Anzahl der Verse, die das Kapitel enthält.
     */
    numberOfVerses: number;

    /**
     * Die Informationen für das Kapitel.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Die Kapitelnummer.
     */
    number: number;

    /**
     * Der Inhalt des Kapitels.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Die Versnummer.
     */
    verse: number;

    /**
     * Die Querverweise für den Vers.
     *
     * Sortiert nach Punktzahl, absteigend.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * Die ID des Buches, auf das Bezug genommen wird.
     */
    book: string;

    /**
     * Die Kapitelnummer.
     */
    chapter: number;

    /**
     * Die Versnummer.
     * Wenn `endVerse` vorhanden ist, dann ist dies der Vers, bei dem die Referenz beginnt.
     */
    verse: number;

    /**
     * Der Vers, bei dem die Bezugnahme endet.
     */
    endVerse?: number;

    /**
     * Der Relevanzwert für die Referenz.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * Die ID der Entität, auf die verwiesen wird.
     */
    id: string;

    /**
     * Der Typ der Entität, auf die verwiesen wird.
     * Entspricht dem Sammlungssegment des API-Links der Entität, sodass der Link als `/api/d/{dataset}/{type}/{id}.json` konstruiert werden kann.
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Der Name der Entität, auf die Bezug genommen wird.
     */
    name?: string;

    /**
     * Der API-Link für die referenzierte Entität.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * Die ID des Buches (GEN, EXO usw.).
     */
    book: string;

    /**
     * Die Kapitelnummer, bei der die Referenz beginnt.
     */
    chapter: number;

    /**
     * Die Versnummer, bei der die Bezugnahme beginnt.
     */
    verse: number;

    /**
     * Der Vers, bei dem die Bezugnahme endet.
     * Aufeinanderfolgende Verse im selben Kapitel werden zu einer einzigen Referenz zusammengefasst.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Die Datensatzinformationen für das Buchkapitel.
     */
    dataset: Dataset;

    /**
     * Die Buchinformationen für das Buchkapitel.
     */
    book: DatasetBook;

    /**
     * Die Entitätsdaten für das Kapitel.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Der Link zu diesem Kapitel.
     */
    thisChapterLink: string;

    /**
     * Der Link zum nächsten Kapitel.
     * Null, falls dies das letzte Kapitel im Datensatz ist.
     */
    nextChapterApiLink: string | null;

    /**
     * Der Link zum vorherigen Kapitel.
     * Null, falls dies das erste Kapitel im Datensatz ist.
     */
    previousChapterApiLink: string | null;

    /**
     * Die Anzahl der Personen, Orte und Ereignisse, die in dem Kapitel vorkommen.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Die Kapitelnummer.
     */
    number: number;

    /**
     * Die Personen, die in diesem Kapitel vorkommen.
     * Sortiert nach der ersten Strophe, in der sie vorkommen.
     */
    people: ChapterPerson[];

    /**
     * Die Orte, die in diesem Kapitel vorkommen.
     * Sortiert nach der ersten Strophe, in der sie vorkommen.
     */
    places: ChapterPlace[];

    /**
     * Die Ereignisse, die in diesem Kapitel beschrieben werden.
     * Sortiert nach der ersten Strophe, in der sie vorkommen.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * Die ID der Person.
     */
    id: string;

    /**
     * Der Name der Person.
     */
    name: string;

    /**
     * Ob es sich bei dem Namen der Person um einen Eigennamen handelt.
     */
    isProperName?: boolean;

    /**
     * Das Geschlecht der Person.
     */
    gender?: string;

    /**
     * Das Geburtsjahr und das Sterbejahr der Person.
     * Negative Zahlen beziehen sich auf die Jahre vor Christus. Positive Zahlen beziehen sich auf die Jahre nach Christus.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Der API-Link für die Person.
     */
    apiLink: string;

    /**
     * Die Nummern der Verse im Kapitel, in denen die Person erwähnt wird.
     * In aufsteigender Reihenfolge sortiert.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * Die ID des Ortes.
     */
    id: string;

    /**
     * Der Name des Ortes.
     */
    name: string;

    /**
     * Die Art des geographischen Merkmals, das der Ort darstellt.
     */
    featureType?: string;

    /**
     * Die geografische Breite und Länge des Ortes.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Der API-Link für den Ort.
     */
    apiLink: string;

    /**
     * Die Nummern der Verse im Kapitel, in denen der Ort erwähnt wird.
     * In aufsteigender Reihenfolge sortiert.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * Die ID des Ereignisses.
     */
    id: string;

    /**
     * Der Name der Veranstaltung.
     */
    name: string;

    /**
     * Das Datum, an dem die Veranstaltung begann.
     */
    startDate?: string;

    /**
     * Der API-Link für die Veranstaltung.
     */
    apiLink: string;

    /**
     * Die Nummern der Verse im Kapitel, die das Ereignis beschreiben.
     * In aufsteigender Reihenfolge sortiert.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Die Datensatzinformationen für die Personen.
     */
    dataset: Dataset;

    /**
     * Die Liste der Personen, die für den Datensatz zur Verfügung stehen.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * Die ID der Person.
     */
    id: string;

    /**
     * Der Name der Person.
     */
    name: string;

    /**
     * Ob es sich bei dem Namen der Person um einen Eigennamen handelt.
     */
    isProperName?: boolean;

    /**
     * Das Geschlecht der Person.
     */
    gender?: string;

    /**
     * Die Anzahl der Bibelstellen, in denen die Person erwähnt wird.
     */
    numberOfReferences: number;

    /**
     * Der API-Link für die Person.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Die Datensatzinformationen für die Person.
     */
    dataset: Dataset;

    /**
     * Die Informationen über die Person.
     */
    person: DatasetPerson;

    /**
     * Der API-Link für diese Person.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * Die ID der Person.
     */
    id: string;

    /**
     * Der Name der Person.
     */
    name: string;

    /**
     * Andere Namen, mit denen die Person gerufen wird.
     */
    alsoCalled?: string[];

    /**
     * Ob es sich bei dem Namen der Person um einen Eigennamen handelt.
     */
    isProperName?: boolean;

    /**
     * Das Geschlecht der Person.
     */
    gender?: string;

    /**
     * Die Beschreibung der Person. Jeder String entspricht einem Absatz.
     */
    description?: string[];

    /**
     * Das Geburtsjahr und das Sterbejahr der Person.
     * Negative Zahlen beziehen sich auf die Jahre vor Christus. Positive Zahlen beziehen sich auf die Jahre nach Christus.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Das früheste und das letzte Jahr, in dem die Person erwähnt wird.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Der Ort, an dem die Person geboren wurde und an dem sie gestorben ist.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Die familiären Beziehungen der Person.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Die Bevölkerungsgruppen, denen die Person angehört.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Die Ereignisse, an denen die Person teilgenommen hat.
     */
    events?: DatasetEntityRef[];

    /**
     * Die Liste der Bibelstellen, in denen die Person erwähnt wird.
     * Sortiert nach Buchreihenfolge, Kapitel und Vers.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Die Datensatzinformationen für die Orte.
     */
    dataset: Dataset;

    /**
     * Die Liste der für den Datensatz verfügbaren Orte.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * Die ID des Ortes.
     */
    id: string;

    /**
     * Der Name des Ortes.
     */
    name: string;

    /**
     * Die Art des geographischen Merkmals, das der Ort darstellt.
     * Zum Beispiel „Stadt“, „Region“, „Berg“, „Wasser“ usw.
     */
    featureType?: string;

    /**
     * Die geografische Breite und Länge des Ortes.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Die Anzahl der Bibelstellen, die den Ort erwähnen.
     */
    numberOfReferences: number;

    /**
     * Der API-Link für den Ort.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Die Datensatzinformationen für den Ort.
     */
    dataset: Dataset;

    /**
     * Die Informationen über den Ort.
     */
    place: DatasetPlace;

    /**
     * Der API-Link für diesen Ort.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * Die ID des Ortes.
     */
    id: string;

    /**
     * Der Name des Ortes.
     */
    name: string;

    /**
     * Der Name des Ortes, wie er in der King-James-Übersetzung und der englischen Standardübersetzung erscheint.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Andere Namen, unter denen der Ort bekannt ist.
     */
    aliases?: string[];

    /**
     * Die Art des geographischen Merkmals, das der Ort darstellt.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * Die geografische Breite und Länge des Ortes und wie genau diese Angaben sind.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Die Beschreibung des Ortes. Jeder String entspricht einem Absatz.
     */
    description?: string[];

    /**
     * Der Kommentar der Autoren des Datensatzes zu diesem Ort.
     */
    comment?: string;

    /**
     * Der Ursprung dieses Ortes.
     * Unterschiedliche Bezeichnungen für denselben geografischen Ort haben denselben Ursprung.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * Der Ort, von dem dieser Ort ein Duplikat ist.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Die Menschen, die an diesem Ort waren, dort geboren wurden oder dort gestorben sind.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Die Ereignisse, die sich an diesem Ort zugetragen haben.
     */
    events?: DatasetEntityRef[];

    /**
     * Die Liste der Bibelstellen, die den Ort erwähnen.
     * Sortiert nach Buchreihenfolge, Kapitel und Vers.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Die Datensatzinformationen für die Ereignisse.
     */
    dataset: Dataset;

    /**
     * Die Liste der Ereignisse, die für den Datensatz verfügbar sind.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * Die ID des Ereignisses.
     */
    id: string;

    /**
     * Der Name der Veranstaltung.
     */
    name: string;

    /**
     * Das Datum, an dem die Veranstaltung begann.
     * Negative Zahlen beziehen sich auf die Jahre vor Christus. Positive Zahlen beziehen sich auf die Jahre nach Christus.
     * Genauere Datumsangaben verwenden das Format `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * Die Anzahl der Bibelstellen, die das Ereignis beschreiben.
     */
    numberOfReferences: number;

    /**
     * Der API-Link für die Veranstaltung.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Die Datensatzinformationen für das Ereignis.
     */
    dataset: Dataset;

    /**
     * Informationen zur Veranstaltung.
     */
    event: DatasetEvent;

    /**
     * Der API-Link für dieses Ereignis.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * Die ID des Ereignisses.
     */
    id: string;

    /**
     * Der Name der Veranstaltung.
     */
    name: string;

    /**
     * Das Datum, an dem die Veranstaltung begann.
     */
    startDate?: string;

    /**
     * Die Dauer der Veranstaltung.
     * Zum Beispiel steht „1D“ für einen Tag und „40Y“ für vierzig Jahre.
     */
    duration?: string;

    /**
     * Die Personen, die an der Veranstaltung teilgenommen haben.
     */
    participants?: DatasetEntityRef[];

    /**
     * Die Orte, an denen das Ereignis stattfand.
     */
    locations?: DatasetEntityRef[];

    /**
     * Die an der Veranstaltung beteiligten Bevölkerungsgruppen.
     */
    groups?: DatasetEntityRef[];

    /**
     * Das Ereignis, zu dem dieses Ereignis gehört.
     */
    partOf?: DatasetEntityRef;

    /**
     * Das Ereignis, das diesem Ereignis vorausging.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Die Liste der Bibelstellen, die das Ereignis beschreiben.
     * Sortiert nach Buchreihenfolge, Kapitel und Vers.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Die Datensatzinformationen für die Bevölkerungsgruppen.
     */
    dataset: Dataset;

    /**
     * Die Liste der für den Datensatz verfügbaren Personengruppen.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * Die Kennung der Volksgruppe.
     */
    id: string;

    /**
     * Der Name der Volksgruppe.
     */
    name: string;

    /**
     * Die Anzahl der Personen, die der Volksgruppe angehören.
     */
    numberOfMembers: number;

    /**
     * Der API-Link für die Personengruppe.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Die Datensatzinformationen für die Personengruppe.
     */
    dataset: Dataset;

    /**
     * Die Informationen über die Volksgruppe.
     */
    group: DatasetPeopleGroup;

    /**
     * Der API-Link für diese Personengruppe.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * Die Kennung der Volksgruppe.
     */
    id: string;

    /**
     * Der Name der Volksgruppe.
     */
    name: string;

    /**
     * Die Personen, die Mitglieder dieser Volksgruppe sind.
     */
    members?: DatasetEntityRef[];

    /**
     * Die Ereignisse, an denen die Volksgruppe teilgenommen hat.
     */
    events?: DatasetEntityRef[];

    /**
     * Die Liste der Bibelstellen, die die Volksgruppe erwähnen.
     * Sortiert nach Buchreihenfolge, Kapitel und Vers.
     */
    references: VerseRef[];
}