• AktivittenApi - axios parameter creator

    Parameters

    Returns {
        getAktivitaet: ((id, format?, options?) => Promise<RequestArgs>);
        getAktivitaetList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDeskriptor?, fDokumentart?, fDokumentnummer?, fDrucksache?, fDrucksachetyp?, fFrageNummer?, fId?, fPlenarprotokoll?, fSachgebiet?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>);
    }

    • getAktivitaet: ((id, format?, options?) => Promise<RequestArgs>)

      Summary

      Liefert Metadaten zu einer Aktivität

      Throws

        • (id, format?, options?): Promise<RequestArgs>
        • Parameters

          • id: number
          • Optional format: "json" | "xml"

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getAktivitaetList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDeskriptor?, fDokumentart?, fDokumentnummer?, fDrucksache?, fDrucksachetyp?, fFrageNummer?, fId?, fPlenarprotokoll?, fSachgebiet?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>)

      Summary

      Liefert eine Liste von Metadaten zu Aktivitäten

      Throws

        • (fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDeskriptor?, fDokumentart?, fDokumentnummer?, fDrucksache?, fDrucksachetyp?, fFrageNummer?, fId?, fPlenarprotokoll?, fSachgebiet?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?): Promise<RequestArgs>
        • Parameters

          • Optional fAktualisiertStart: string

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

          • Optional fAktualisiertEnd: string

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

          • Optional 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.

          • Optional 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.

          • Optional 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.

          • Optional fDokumentart: "Drucksache" | "Plenarprotokoll"

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

          • Optional 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.

          • Optional fDrucksache: number

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

          • Optional fDrucksachetyp: string

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

          • Optional 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.

          • Optional fId: number[]

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

          • Optional fPlenarprotokoll: number

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

          • Optional 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.

          • Optional 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.

          • Optional 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.

          • Optional 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.

          • Optional 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.

          • Optional fZuordnung: Zuordnung

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

          • Optional 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.

          • Optional format: "json" | "xml"

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

    Export

Generated using TypeDoc