getChildUserGroupsByMarker

Getting the child groups of a user group.

Description

This method retrieves the child groups of a user group by the marker of the parent. Nesting is walked with this method rather than through parentId. A group with no children returns an empty array. It returns a Promise that resolves to an array of IUserGroupEntity objects.

UserGroups.getChildUserGroupsByMarker(marker, langCode);

Parameters

marker: string
Text identifier of the parent user group.
example: "guest"

langCode: string (optional)
Language code. Default: "en_US".
example: "en_US"

Examples

Minimal example

const response = await UserGroups.getChildUserGroupsByMarker('guest');

Example response

[]

Response schema

Schema: IUserGroupEntity[]

id: number
Identifier of the user group.
example: 1

depth: number
Nesting depth relative to the parent.
example: 0

parentId: number | null
Identifier of the parent group, null for a top-level group.
example: null

localizeInfos: ILocalizeInfo
Title of the group, taking localization into account.

isVisible: boolean
Visibility flag.
example: true

childrenCount: string
Number of child groups. The API sends it as a string, not a number.
example: "0"

identifier: string
Text identifier (marker) of the group.
example: "guest"

isSync: boolean
Synchronization flag.
example: false

attributeValues: IAttributeValues
Attribute values of the group.

version: number
Version of the object. Not present on every stand.
example: NaN

---