Skip to main content

@idpass/data-collect-core / DetailGroupDoc

Interface: DetailGroupDoc

Defined in: interfaces/types.ts:194

Detailed group document with member information loaded.

Used for displaying complete group information including member details.

Extends​

Properties​

id​

id: string

Defined in: interfaces/types.ts:58

Internal database ID (auto-generated)

Inherited from​

GroupDoc.id

guid​

guid: string

Defined in: interfaces/types.ts:60

Global unique identifier (user-provided or generated)

Inherited from​

GroupDoc.guid

externalId?​

optional externalId: string

Defined in: interfaces/types.ts:62

Optional external system identifier for sync

Inherited from​

GroupDoc.externalId

name?​

optional name: string

Defined in: interfaces/types.ts:64

Optional display name for the entity

Inherited from​

GroupDoc.name

version​

version: number

Defined in: interfaces/types.ts:68

Version number for optimistic concurrency control

Inherited from​

GroupDoc.version

data​

data: Record<string, any>

Defined in: interfaces/types.ts:71

Flexible data payload containing entity-specific fields

Inherited from​

GroupDoc.data

lastUpdated​

lastUpdated: string

Defined in: interfaces/types.ts:73

ISO timestamp of last modification

Inherited from​

GroupDoc.lastUpdated

identifiers?​

optional identifiers: IdentifierRecord[]

Defined in: interfaces/types.ts:75

Multiple typed identifiers per entity (national ID, UNHCR ID, etc.)

Inherited from​

GroupDoc.identifiers

type​

type: Group

Defined in: interfaces/types.ts:141

Type of entity (Individual or Group)

Inherited from​

GroupDoc.type

memberIds​

memberIds: string[]

Defined in: interfaces/types.ts:143

Array of entity GUIDs that are members of this group

Inherited from​

GroupDoc.memberIds

membershipRecords?​

optional membershipRecords: MembershipRecord[]

Defined in: interfaces/types.ts:145

Typed membership records (replaces flat memberIds for rich membership data)

Inherited from​

GroupDoc.membershipRecords

memberCount​

memberCount: number

Defined in: interfaces/types.ts:196

Number of members in this group

missing?​

optional missing: true

Defined in: interfaces/types.ts:198

Indicates if the group is missing/not found

members​

members: DetailEntityDoc[] | DetailGroupDoc[]

Defined in: interfaces/types.ts:200

Loaded member entities (can be nested groups)