Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Donor typeDetails
Adult donor
Expand
titleRequest...

grid*

string
nullable: true

maxLength: 19

minLength: 19

example: 9991012070433202000
CBU
Expand
titleRequest...

id*

string
maxLength: 17
example: CB1234567

CBU Identification2 (formerly CB_ID)

ADCU
Expand
titleRequest...

id*

string
maxLength: 16
example: A99991412345612N

N/A in EMDIS, available in the future

...

Note: The concept of the REF_CODE field used in EMDIS is replaced by the GUID assigned by the central system to each message. The Message Response is supposed to be using the GUID of the original message as the Reference ID in its structure.

Message structure:

Send (Post)Retrieve (Post)
MessageResponse
Expand
titleRequest...
FieldDetails
organisationResponse
Expand
title...
FieldDetails
retrievedAtUtc*string($date-time)

Server-supplied timestamp showing time of Message retrieval and storage in organisation's own systems

referenceMessageId*string($uuid)
responseType*

string

Enum:
Array [ 3 ]

remark

string


Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100

shouldPeekboolean
default: false

Set to true if you want messages to remain available after retrieval

Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

...