Skip to content

hmrc/secure-message-frontend

Repository files navigation

secure-message-frontend

Overview

Secure message frontend is a microservice to allow other services to integrate with secure messages inbox & retrieve the message partials.

Integration

Service endpoints

Path Supported Methods Description
/:clientService/messages GET returns HTML partial with list of messages.
/:clientService/messages/:id GET returns HTML partial with list of messages for a given conversation id.
/:clientService/messages/result GET returns HTML partial with list of messages in the conversation.
/messages/count GET returns JSON containing the message count.

Message frontend endpoints

Path Supported Methods Description
/messages GET returns HTML partial with list of messages for current authenticated user.
/messages/bta GET returns HTML partial with list of messages for current authenticated user for BTA.
/messages/:encryptedUrl GET returns HTML Partial containing the formatted message
/messages/inbox-link GET returns HTML Partial containing the formatted message count
/messages/count GET returns JSON containing the message count

Integration Testing

sm2 --start DC_SECURE_MESSAGE_FRONTEND_IT sbt it / test sm2 --stop DC_SECURE_MESSAGE_FRONTEND_IT

Run the project locally

sbt "run 9055 -Dplay.http.router=testOnlyDoNotUseInAppConf.Routes"

SBT tasks

# Format the code
sbt fmt

# Clean, build test and integration test
sbt clean test it/test

# Run a coverage report
sbt clean coverage test coverageReport

License

This code is open source software licensed under the Apache 2.0 License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 19

Languages