Function PersonenstammdatenApiAxiosParamCreator

  • PersonenstammdatenApiAxiosParamCreator(configuration?): {
        getPerson: ((id, format?, options?) => Promise<RequestArgs>);
        getPersonList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fId?, fWahlperiode?, cursor?, format?, options?) => Promise<RequestArgs>);
    }

  • PersonenstammdatenApi - axios parameter creator

    Parameters

    Returns {
        getPerson: ((id, format?, options?) => Promise<RequestArgs>);
        getPersonList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fId?, fWahlperiode?, cursor?, format?, options?) => Promise<RequestArgs>);
    }

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

      Summary

      Liefert Personenstammdaten zu einer Person

      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>

    • getPersonList: ((fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fId?, fWahlperiode?, cursor?, format?, options?) => Promise<RequestArgs>)

      Summary

      Liefert eine Liste von Personenstammdaten

      Throws

        • (fAktualisiertStart?, fAktualisiertEnd?, fDatumStart?, fDatumEnd?, fId?, fWahlperiode?, 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 fId: number[]

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

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

    Export

Settings

Member Visibility

Theme

Generated using TypeDoc