Interface PersonenstammdatenApiGetPersonListRequest

Request parameters for getPersonList operation in PersonenstammdatenApi.

Export

PersonenstammdatenApiGetPersonListRequest

interface PersonenstammdatenApiGetPersonListRequest {
    cursor?: string;
    fAktualisiertEnd?: string;
    fAktualisiertStart?: string;
    fDatumEnd?: string;
    fDatumStart?: string;
    fId?: number[];
    fWahlperiode?: number[];
    format?: "json" | "xml";
}

Index

Properties

cursor? fAktualisiertEnd? fAktualisiertStart? fDatumEnd? fDatumStart? fId? fWahlperiode? format?

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

PersonenstammdatenApiGetPersonList

`Optional` `Readonly` fAktualisiertEnd

fAktualisiertEnd?: string

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

Memberof

PersonenstammdatenApiGetPersonList

`Optional` `Readonly` fAktualisiertStart

fAktualisiertStart?: string

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

Memberof

PersonenstammdatenApiGetPersonList

`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

PersonenstammdatenApiGetPersonList

`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

PersonenstammdatenApiGetPersonList

`Optional` `Readonly` fId

fId?: number[]

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

Memberof

PersonenstammdatenApiGetPersonList

`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

PersonenstammdatenApiGetPersonList

`Optional` `Readonly` format

format?: "json" | "xml"

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

Memberof

PersonenstammdatenApiGetPersonList

Generated using TypeDoc