Versions Compared

Old Version 135

changes.mady.by.user Mark Melchers

Saved on

compared with

New Version 136

changes.mady.by.user Mark Melchers

Saved on

Key

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

...

FieldDetails
limit*integer
default: 100
shouldPeekboolean
default: false
totalCount*integer
minimum: 0
example: 1
remainingCount*integer
minimum: 0
isSuccessful*boolean
default: true
summary*

string
maxLength: 255
example: 1 message retrieved successfully. 0 remaining messages.

6.2 Message Response

The message response is intended as an automated response to every user generated message. It serves three purposes:

...

Send (Post)Retrieve (Post)
MessageResponseMessageResponseRequest 

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

messageSequenceNumber

integer
examplet: 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...
FieldDetails
generalInformation*Embedded General Information Block
originalMessage{...}
metaInformationEmbedded Meta Block

...

Retrieve (Post)
availableMessagesAll
Expand
titleRequest...
FieldDetails
limitinteger
default: 100
shouldPeekboolean
default: false

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

Expand
titleResponse...
FieldDetails
generalInformation*
Expand
title...
FieldDetails
limit*

integer

default: 100

shouldPeek

boolean

default: false

totalCount*

integer

minimum: 0
example: 1

remainingCount*

integer

minimum: 0

isSuccessful*

boolean

default: true

summary*

string

maxLength: 255
example: 1 message retrieved sucessully. 0 remaining messages

messages*
Expand
title...
FieldDetails
originalMessage*

oneOf:

alert
ping
textMessageRequest
genericRequest
extededTypingRequest
typingResponse
sampleRequest
sampleArrival
sampleInfo
sampleResponse
infectiousDiseaseMarker
infectiousDiseaseMarkerResult
reservationRequest
reservationResponse
reservationRelease
requestCancellation
requestRejected
resultReminder
cordBloodUnitReportRequest
cordBloodUnitReportResponse

metaInformation*

{...}

...