7 Data Structures

This section provides information on the core data structures/data models that are used by this Building Block.

7.1 Resource Model

The resource model shows the relationship between data objects that are used by this Building Block.

Note: Recommend using https://app.diagrams.net/ to create the resource model and store in Building Block repository (https://github.com/GovStackWorkingGroup/bb-messaging/tree/1.0-QA/api)

7.2 Data Structures

7.2.1 Data Elements (Generic Example)

7.2.1.1 Person

Name
Type
Description
Notes

Name

Type

Description

Notes

Surname

String

Family name

First Name

String

First name

Birth Date

Date

DOB

Mobile Number

String

Phone number (mobile) of user

E.164 Mobile number standard. Should include country code.

Government ID number

Integer

Government issued ID number

Used when linking to global ID Building Block.

Model Schemas

Each model schema MUST have a corresponding JSON Schema (API definition file).

Last updated

Was this helpful?