Function VorgngeApiFactory

Returns {
    getVorgang(id, format?, options?): AxiosPromise<Vorgang>;
    getVorgangList(fAktualisiertStart?, fAktualisiertEnd?, fBeratungsstand?, fDatumStart?, fDatumEnd?, fDeskriptor?, fDokumentart?, fDokumentnummer?, fDrucksache?, fDrucksachetyp?, fFrageNummer?, fGesta?, fId?, fInitiative?, fPlenarprotokoll?, fRessortFdf?, fSachgebiet?, fTitel?, fUrheber?, fVerkuendungFundstelle?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, cursor?, format?, options?): AxiosPromise<VorgangListResponse>;
}

• getVorgang:function

  • getVorgang(id, format?, options?): AxiosPromise<Vorgang>

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

    Summary

    Liefert Metadaten zu einem Vorgang

    Throws

• getVorgangList:function

  • getVorgangList(fAktualisiertStart?, fAktualisiertEnd?, fBeratungsstand?, fDatumStart?, fDatumEnd?, fDeskriptor?, fDokumentart?, fDokumentnummer?, fDrucksache?, fDrucksachetyp?, fFrageNummer?, fGesta?, fId?, fInitiative?, fPlenarprotokoll?, fRessortFdf?, fSachgebiet?, fTitel?, fUrheber?, fVerkuendungFundstelle?, fVorgangstyp?, fVorgangstypNotation?, fWahlperiode?, cursor?, format?, options?): AxiosPromise<VorgangListResponse>

  • 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 fBeratungsstand: string[]

      Beratungsstand Selektiert alle Entitäten, die dem angegebenen Beratungsstand zugeordnet sind. Kann wiederholt werden, um mehrere Beratungsstände zu selektieren. Hinterlegt ist eine ODER-Suche.
    • 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 fGesta: string[]

      GESTA-Ordnungsnummer Selektiert alle Entitäten, die der angegebenen GESTA-Ordnungsnummer zugeordnet sind. Kann wiederholt werden, um mehrere Ordnungsnummern zu selektieren. Hinterlegt ist eine ODER-Suche.
    • Optional fId: number[]

      ID der Entität Kann wiederholt werden, um mehrere Entitäten zu selektieren.
    • Optional fInitiative: string[]

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

      ID eines verknüpften Plenarprotokolls Selektiert alle Entitäten, die mit dem angegebenen Plenarprotokoll verknüpft sind.
    • 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 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 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 fVerkuendungFundstelle: string[]

      Fundstelle der Verkündung Selektiert alle Entitäten, welche den angegebenen Suchbegriff in der Fundstelle der Verkündung enthalten. Kann wiederholt werden, um mehrere Fundstellen zu selektieren. Hinterlegt ist eine ODER-Suche. Eine Einzelwortsuche (z.B. nach dem Verkündungsblatt) ist möglich.
    • 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 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 AxiosPromise<VorgangListResponse>

    Summary

    Liefert eine Liste von Metadaten zu Vorgängen

    Throws