Versions Compared

Old Version 99

changes.mady.by.user Rimke Postel

Saved on

compared with

New Version 100

changes.mady.by.user Rimke Postel

Saved on

Key

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

...

FieldDetails
deliveredAtUtc*string($date-time)

Server-supplied timestamp showing time of Message delivery to receiving registry's inbox queue

referenceMessageId*string($uuid)
responseType*

stringEnum:
Array [  Success, Warning, Acknowledge, Failed]

messages can be failed, if the message has a structure or information that prevent delivery to the receiving registry. This could be incorrect JSON structure and non-existent ION or because the receiving registry does not allow messages from your registry. 

wmdaRemark[...]

...

Message structure:

SendRetrieve
MessageResponse

MessageResponseRetrieve

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

No parameters specified

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

...

Message structure:

SendRetrieve
textMessageRequest

textMessageRetrieve

Expand
titleRequest...
title

string
nullable: true

Text. Message for a human at receiving registry.

 string($date-time)

nullable: true

Date sent SENT_DATE Opt 8

Field

Details

messagetext*
Expand
...
FieldDetails
textsentDate
receivingRegistry*string
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of the receiving registry

patient*Patient ID
donor*Donor ID
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

No parameters specified

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

...

SendRetrieve

AlertRetrieve
Alerts can only be sent by the WMDA's central system
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

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

Expand
titleResponse...
FieldDetails
originalMessage
Expand
title...
FieldDetails
levelstring

alert level. enums may change

Enum:
Array [ 3 ]
statusstring

check later

Enum:
Array [ 2 ]
messagestring
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march
metaInformationEmbedded Meta Block

...

SendRetrieve

AlertUpdateRetrieve
Alert updates can only be sent by the WMDA's central system
Expand
titleRequest...
limitinteger
default: 100
shouldPeekboolean
default: false

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

Expand
titleResponse...
FieldDetails
originalMessage
Expand
title...
FieldDetails
alertReferenceIdentifierstring($uuid)
levelstring

alert level. enums may change

Enum:
Array [ 3 ]
statusstring

check later

Enum:
Array [ 2 ]
messagestring
maxLength: 1024
example: WMDA will do maintenance on SMC system on the weekend of 10 march
metaInformationEmbedded Meta Block

...