Function DrucksachenApiAxiosParamCreator

  • DrucksachenApiAxiosParamCreator(configuration?): {
        getDrucksache: ((id, format?, options?) => Promise<RequestArgs>);
        getDrucksacheList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>);
        getDrucksacheText: ((id, format?, options?) => Promise<RequestArgs>);
        getDrucksacheTextList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>);
    }

  • DrucksachenApi - axios parameter creator

    Parameters

    Returns {
        getDrucksache: ((id, format?, options?) => Promise<RequestArgs>);
        getDrucksacheList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>);
        getDrucksacheText: ((id, format?, options?) => Promise<RequestArgs>);
        getDrucksacheTextList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>);
    }

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

      Summary

      Liefert Metadaten zu einer Drucksache

      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>

    • getDrucksacheList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>)

      Summary

      Liefert eine Liste von Metadaten zu Drucksachen

      Throws

        • (fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, 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 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 fDrucksachetyp: string

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

          • Optional fId: number[]

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

          • Optional fRessortFdf: string[]

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

          • Optional fTitel: string[]

            Titel Selektiert alle Entitäten, die den angegebenen Suchbegriff im Titel enthalten. Kann wiederholt werden, um mehrere Titel zu selektieren. Hinterlegt ist eine ODER-Suche. Eine Einzelwortsuche ist möglich. Mehrere Suchbegriffe hintereinander werden als Phrase gesucht.

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

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

      Summary

      Liefert Volltext und Metadaten zu einer Drucksache

      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>

    • getDrucksacheTextList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, fUrheber?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, fZuordnung?, cursor?, format?, options?) => Promise<RequestArgs>)

      Summary

      Liefert eine Liste von Volltexten und Metadaten zu Drucksachen

      Throws

        • (fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fDokumentnummer?, fDrucksachetyp?, fId?, fRessortFdf?, fTitel?, 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 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 fDrucksachetyp: string

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

          • Optional fId: number[]

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

          • Optional fRessortFdf: string[]

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

          • Optional fTitel: string[]

            Titel Selektiert alle Entitäten, die den angegebenen Suchbegriff im Titel enthalten. Kann wiederholt werden, um mehrere Titel zu selektieren. Hinterlegt ist eine ODER-Suche. Eine Einzelwortsuche ist möglich. Mehrere Suchbegriffe hintereinander werden als Phrase gesucht.

          • 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

Settings

Member Visibility

Theme

Generated using TypeDoc