Versions Compared

Key

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

...

Send (Post)
Retrieve (Post)
sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
Expand
titleRequest...
message*
Expand
title...
requestIdstring
maxLength: 15
example:XX12345
referenceCode*string($uuid)
informationType*string
maxLength: 3

minLength: 3

Information Type INFO_TYPE Req 3

Enum:
Array [ 12 ]
remarkstring
nullable: true

Remark REMARK Opt 120

receivingRegistry*integer
maximum: 9999

minimum: 0

maxLength: 4

minLength: 4

example: 1234

4-digit ION of the receiving registry

patient*

Patient wmdaId ID provided by the WMDA

donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponse*Embedded WMDA Response Block
Expand
titleRequest...
limitinteger
default: 100

shouldPeekboolean
default: false

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

messageSequenceNumber

integer
e
xamplet: 12345

Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned.

Expand
titleResponse...
generalInformation*Embedded General Information Block
originalMessage*{...}
metaInformation*Embedded Meta Block

...