Versions Compared

Key

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

Table of Contents

6.1 Embedded blocks

6.1.1 Embedded Meta block

...

Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx

6.2 Message Response

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

...

SendRetrieve
post_api_v1_MessageResponse
  • Reference ID (GUID)
  • Response type
    • message acknowledgment
    • warning
    • message denial
  • Remark - a string explaining the reason for a denial or a warning, empty for acknowledgment

MessageResponse payload

Meta block (6.1.1)

6.3 Text message [TXT_MSG]

The TXT_MSG is useful to convey notes or comments pertaining to a particular patient, donor, or patient/donor pair.

...

SendRetrieve
post_api_v1_TextMessageRequest
  • Patient
  • Donor
  • Text

TextMessage payload

Meta block (6.1.1)

6.4 Alert message

The Alert message is used to broadcast an important information about the system, like planned service outage. Messages are generated centrally by WMDA. Members are expected to display them to the users.

...

SendRetrieve

get_api_v1_AlertRetrieve
Alerts can only be sent by the WMDA's central system

Alert Payload:

  • Level
  • Status
  • Message

Meta block (6.1.1)

6.5 Alert Update message

The Alert  Update message is used to broadcast an update about some previous alert. Messages are generated centrally by WMDA. Members are expected to display them to the users.

...