Notice

This service has been deprecated & will be decommissioned eventually in favour of secure-message-frontend

message-frontend

UI partials for viewing messages

API

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 More...
/messages/inbox-link	GET	returns HTML Partial containing the formatted message count
/messages/count	GET	returns JSON containing the message count More...

GET /messages

Accepts optional parameters:

Name	Values	Default	Description
taxIdentifiers	nino, sautr, ctutr	List("nino", "sautr")	Filter the messages to only show messages associated with the specified tax identifiers.

GET /messages/bta

Accepts optional parameters:

Name	Values	Default	Description
taxIdentifiers	nino, sautr, ctutr	List("nino", "sautr")	Filter the messages to only show messages associated with the specified tax identifiers.

GET /messages/:encryptedUrl

encryptedUrl is an encrypted URL generated by this service to render a specific message.

GET /messages/count

Accepts optional parameters:

Name	Values	Default	Description
read	Yes,No, Both	Both	Yes will return only messages that have been already read, No will return only unread messages and Both will return all messages
taxIdentifiers	nino, sautr, ctutr	List("nino", "sautr")	Filter the count to only show messages associated with the specified tax identifiers.

GET /messages/inbox-link

Required parameters:

Name	Description
messagesInboxUrl	The Url that will be used if the user clicks on the returned link.

Accepts optional parameters:

Name	Values	Default	Description
taxIdentifiers	nino, sautr, ctutr	List("nino", "sautr")	Filter the count in the link to only account for messages associated with the specified tax identifiers.

Example response:

{
   "count" : 5 
}