@idpass/data-collect-core / RecordDoc

Interface: RecordDoc

Defined in: interfaces/types.ts:173

Activity record entity (training, referral, home visit, assistance, etc.).

Records are entities that capture activities or services linked to an individual or group, but are not themselves people or households.

Extends

• EntityDoc

Properties

id

id: string

Defined in: interfaces/types.ts:58

Internal database ID (auto-generated)

Inherited from

EntityDoc.id

---

guid

guid: string

Defined in: interfaces/types.ts:60

Global unique identifier (user-provided or generated)

Inherited from

EntityDoc.guid

---

externalId?

optional externalId: string

Defined in: interfaces/types.ts:62

Optional external system identifier for sync

Inherited from

EntityDoc.externalId

---

name?

optional name: string

Defined in: interfaces/types.ts:64

Optional display name for the entity

Inherited from

EntityDoc.name

---

version

version: number

Defined in: interfaces/types.ts:68

Version number for optimistic concurrency control

Inherited from

EntityDoc.version

---

data

data: Record<string, any>

Defined in: interfaces/types.ts:71

Flexible data payload containing entity-specific fields

Inherited from

EntityDoc.data

---

lastUpdated

lastUpdated: string

Defined in: interfaces/types.ts:73

ISO timestamp of last modification

Inherited from

EntityDoc.lastUpdated

---

identifiers?

optional identifiers: IdentifierRecord[]

Defined in: interfaces/types.ts:75

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

Inherited from

EntityDoc.identifiers

---

type

type: Record

Defined in: interfaces/types.ts:174

Type of entity (Individual or Group)

Overrides

EntityDoc.type

---

parentEntityGuid?

optional parentEntityGuid: string

Defined in: interfaces/types.ts:176

GUID of the parent entity this record belongs to (optional)