Versions Compared

Key

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

...

NameTypeMandatoryDescription
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
typeENUMNo

Possible values: ['email', 'alert'].

Default value: "email".

This parameter identifies the type of message that must be sent.

senderIdStringIf type == 'email' -> No
If type == 'alert' -> Yes 
Id of the user used as sender. For messages of type 'email', this parameter is not mandatory. In this case, the sender is set as the receiver.
receiverIdStringYesId of the user that must receive the message.
templateIdStringYesId of the template that should be used for the message.
...StringNoAll the parameters (all the previously listed and any other parameter used in the invocation of this operation) are used as variables for the selected template. The template then could have, for example, the following variables: {userId}, {type}, {username}, {doctor}, etc.
Note
titleImportant
Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/communication/send?token=d56c8e42-395e-4ba1-9bbb-73e5ed403f51&userId=poda&type=email&receiverId=354a7aae-ac06-4892-ac61-ce302351eb35&templateId=PasswordReset&link=http://fakeLink.com

...