Interface AktivittenApiGetAktivitaetListRequest

Request parameters for getAktivitaetList operation in AktivittenApi.

Export

AktivittenApiGetAktivitaetListRequest

interface AktivittenApiGetAktivitaetListRequest {
    cursor?: string;
    fAktualisiertEnd?: string;
    fAktualisiertStart?: string;
    fDatumEnd?: string;
    fDatumStart?: string;
    fDeskriptor?: string[];
    fDokumentart?: "Drucksache" | "Plenarprotokoll";
    fDokumentnummer?: string[];
    fDrucksache?: number;
    fDrucksachetyp?: string;
    fFrageNummer?: string[];
    fId?: number[];
    fPlenarprotokoll?: number;
    fSachgebiet?: string[];
    fUrheber?: string[];
    fVorgangstyp?: string[];
    fVorgangstypNotation?: number[];
    fWahlperiode?: number[];
    fZuordnung?: Zuordnung;
    format?: "json" | "xml";
}

Properties

`Optional` `Readonly` cursor

cursor?: string

Position des Cursors zur Anfrage weiterer Entitäten Übersteigt die Anzahl der gefundenen Entitäten das jeweilige Limit, muss eine Folgeanfrage gestellt werden, um weitere Entitäten zu laden. Eine Folgeanfrage wird gebildet, indem alle Parameter der ursprünglichen Anfrage wiederholt werden und zusätzlich der cursor Parameter der letzten Antwort eingesetzt wird. Es können solange Folgeanfragen gestellt werden, bis sich der cursor nicht mehr ändert. Dies signalisiert, dass alle Entitäten geladen wurden.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fAktualisiertEnd

fAktualisiertEnd?: string

Spätestes Aktualisierungsdatum der Entität Selektiert Entitäten in einem Datumsbereich basierend auf dem letzten Aktualisierungsdatum.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fAktualisiertStart

fAktualisiertStart?: string

Frühestes Aktualisierungsdatum der Entität Selektiert Entitäten in einem Datumsbereich basierend auf dem letzten Aktualisierungsdatum.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDatumEnd

fDatumEnd?: string

Spätestes Datum der Entität Selektiert Entitäten in einem Datumsbereich basierend auf dem Dokumentdatum. Für Vorgänge und Personen wird der Datumsbereich aller zugehörigen Dokumente herangezogen.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDatumStart

fDatumStart?: string

Frühestes Datum der Entität Selektiert Entitäten in einem Datumsbereich basierend auf dem Dokumentdatum. Für Vorgänge und Personen wird der Datumsbereich aller zugehörigen Dokumente herangezogen.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDeskriptor

fDeskriptor?: string[]

Deskriptor Selektiert alle Entitäten, die mit dem angegebenen Deskriptor verknüpft sind. Kann wiederholt werden, um die Schnittmenge mehrerer Deskriptoren zu selektieren. Hinterlegt ist eine UND-Suche. Eine ODER-Suche über mehrere Deskriptoren ist mit einer einzigen Abfrage nicht möglich. Die Deskriptoren müssen dazu einzeln abgefragt werden.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDokumentart

fDokumentart?: "Drucksache" | "Plenarprotokoll"

Drucksache oder Plenarprotokoll Selektiert alle Entitäten, die mit der angegebenen Dokumentart verknüpft sind.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDokumentnummer

fDokumentnummer?: string[]

Dokumentnummer einer Drucksache oder eines Plenarprotokolls Selektiert alle Entitäten, die mit der angegebenen Dokumentnummer verknüpft sind. Kann wiederholt werden, um mehrere Dokumentnummern zu selektieren. Hinterlegt ist eine ODER-Suche.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDrucksache

fDrucksache?: number

ID einer verknüpften Drucksache Selektiert alle Entitäten, die mit der angegebenen Drucksache verknüpft sind.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fDrucksachetyp

fDrucksachetyp?: string

Typ der Drucksache Selektiert alle Entitäten, die mit dem angegebenen Drucksachetyp verknüpft sind.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fFrageNummer

fFrageNummer?: string[]

Fragenummer/Listenziffer Selektiert alle Entitäten, die mit der angegebenen Fragenummer in einer Drucksache verknüpft sind. Kann wiederholt werden, um mehrere Fragenummern zu selektieren. Hinterlegt ist eine ODER-Suche.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fId

fId?: number[]

ID der Entität Kann wiederholt werden, um mehrere Entitäten zu selektieren.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fPlenarprotokoll

fPlenarprotokoll?: number

ID eines verknüpften Plenarprotokolls Selektiert alle Entitäten, die mit dem angegebenen Plenarprotokoll verknüpft sind.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fSachgebiet

fSachgebiet?: string[]

Sachgebiet Selektiert alle Entitäten, die mit dem angegebenen Sachgebiet verknüpft sind. Kann wiederholt werden, um die Schnittmenge mehrerer Sachgebiete zu selektieren. Hinterlegt ist eine UND-Suche. Eine ODER-Suche über mehrere Sachgebiete ist mit einer einzigen Abfrage nicht möglich. Die Sachgebiete müssen dazu einzeln abgefragt werden.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fUrheber

fUrheber?: string[]

Urheber Selektiert alle Entitäten, die mit dem angegebenen Urheber in einer Drucksache verknüpft sind. Kann wiederholt werden, um die Schnittmenge mehrerer Urheber zu selektieren. Hinterlegt ist eine UND-Suche. Eine ODER-Suche über mehrere Urheber ist mit einer einzigen Abfrage nicht möglich. Die Urheber müssen dazu einzeln abgefragt werden.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fVorgangstyp

fVorgangstyp?: string[]

Vorgangstyp Selektiert alle Entitäten, die dem angegebenen Vorgangstyp zugeordnet sind. Kann wiederholt werden, um mehrere Vorgangstypen zu selektieren. Hinterlegt ist eine ODER-Suche.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fVorgangstypNotation

fVorgangstypNotation?: number[]

Vorgangstyp-Notation Selektiert alle Entitäten, die der angegebenen Vorgangstyp-Notation zugeordnet sind. Kann wiederholt werden, um mehrere Vorgangstypen zu selektieren. Hinterlegt ist eine ODER-Suche.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fWahlperiode

fWahlperiode?: number[]

Nummer der Wahlperiode Selektiert alle Entitäten, die der angegebenen Wahlperiode zugeordnet sind. Kann wiederholt werden, um mehrere Wahlperioden zu selektieren. Hinterlegt ist eine ODER-Suche.

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` fZuordnung

fZuordnung?: Zuordnung

Zuordnung der Entität zum Bundestag, Bundesrat, Bundesversammlung oder Europakammer

Memberof

AktivittenApiGetAktivitaetList

`Optional` `Readonly` format

format?: "json" | "xml"

Steuert das Datenformat der Antwort, möglich sind JSON (voreingestellt) oder XML.

Memberof

AktivittenApiGetAktivitaetList

Generated using TypeDoc