getUserGroupById

Obteniendo un único objeto de grupo de usuario por su identificador.

Descripción

Este método recupera un único objeto de grupo de usuario por su identificador. Devuelve una Promesa que se resuelve en un objeto IUserGroupEntity.

UserGroups.getUserGroupById(id, langCode);

Parámetros

id: number
Identificador del grupo de usuario.
ejemplo: 1

langCode: string (opcional)
Código de idioma. Predeterminado: "en_US".
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await UserGroups.getUserGroupById(1);

Ejemplo de respuesta

{
  "id": 1,
  "depth": 0,
  "parentId": null,
  "localizeInfos": {
    "title": "Guest"
  },
  "isVisible": true,
  "childrenCount": "0",
  "identifier": "guest",
  "isSync": false,
  "attributeValues": {},
  "version": 0
}

Esquema de respuesta

Esquema: IUserGroupEntity

id: number
Identificador del grupo de usuario.
ejemplo: 1

depth: number
Profundidad de anidamiento relativa al padre.
ejemplo: 0

parentId: number | null
Identificador del grupo padre, null para un grupo de nivel superior.
ejemplo: null

localizeInfos: ILocalizeInfo
Título del grupo, teniendo en cuenta la localización.

isVisible: boolean
Indicador de visibilidad.
ejemplo: true

childrenCount: string
Número de grupos hijos. La API lo envía como una cadena, no como un número.
ejemplo: "0"

identifier: string
Identificador de texto (marcador) del grupo.
ejemplo: "guest"

isSync: boolean
Indicador de sincronización.
ejemplo: false

attributeValues: IAttributeValues
Valores de atributos del grupo.

version: number
Versión del objeto. No presente en cada stand.
ejemplo: NaN

---