Freigeben über


GetPersonGroups interface

Methoden

get(GetPersonGroupsParameters)

Personengruppen werden in alphabetischer Reihenfolge von personGroupId gespeichert.

    • Der Parameter "start" (Zeichenfolge, optional) gibt einen ID-Wert an, von dem zurückgegebene Einträge basierend auf dem Zeichenfolgenvergleich größere IDs aufweisen. Wenn "Start" auf einen leeren Wert festgelegt wird, wird angegeben, dass Einträge beginnend mit dem ersten Element zurückgegeben werden sollen.
    • Der Parameter "top" (int, optional) bestimmt die maximale Anzahl der zurückzugebenden Einträge mit einem Grenzwert von bis zu 1000 Einträgen pro Aufruf. Wenn Sie zusätzliche Einträge über diesen Grenzwert hinaus abrufen möchten, geben Sie "start" mit der personId des letzten Eintrags an, der im aktuellen Aufruf zurückgegeben wurde.

Trinkgeld

  • Beispielsweise gibt es insgesamt fünf Elemente mit ihren IDs: "itemId1", ..., "itemId5".
    • "start=&top=" gibt alle fünf Elemente zurück.
    • "start=&top=2" gibt "itemId1", "itemId2" zurück.
    • "start=itemId2&top=3" gibt "itemId3", "itemId4", "itemId5" zurück.

Details zur Methode

get(GetPersonGroupsParameters)

Personengruppen werden in alphabetischer Reihenfolge von personGroupId gespeichert.

    • Der Parameter "start" (Zeichenfolge, optional) gibt einen ID-Wert an, von dem zurückgegebene Einträge basierend auf dem Zeichenfolgenvergleich größere IDs aufweisen. Wenn "Start" auf einen leeren Wert festgelegt wird, wird angegeben, dass Einträge beginnend mit dem ersten Element zurückgegeben werden sollen.
    • Der Parameter "top" (int, optional) bestimmt die maximale Anzahl der zurückzugebenden Einträge mit einem Grenzwert von bis zu 1000 Einträgen pro Aufruf. Wenn Sie zusätzliche Einträge über diesen Grenzwert hinaus abrufen möchten, geben Sie "start" mit der personId des letzten Eintrags an, der im aktuellen Aufruf zurückgegeben wurde.

Trinkgeld

  • Beispielsweise gibt es insgesamt fünf Elemente mit ihren IDs: "itemId1", ..., "itemId5".
    • "start=&top=" gibt alle fünf Elemente zurück.
    • "start=&top=2" gibt "itemId1", "itemId2" zurück.
    • "start=itemId2&top=3" gibt "itemId3", "itemId4", "itemId5" zurück.
function get(options?: GetPersonGroupsParameters): StreamableMethod<GetPersonGroups200Response | GetPersonGroupsDefaultResponse>

Parameter

Gibt zurück