This is an inbound web service invoked by remote systems on Universal Access. It is used to send Citizen Messages that are displayed on a user's Home Page when they log into the Citizen Account. The schema for the payload of web service requests of this type can be found in <CURAM_DIR>\EJBServer\components\WorkspaceServices\webservices\ExternalCitizenMessage.xsd. A sample SOAP request for this web service is published in Appendix A.
This web service request contains the following information:
- sourceSystem – The name of the remote system sending the request.
- citizenWorkspaceAccountID – The unique citizen workspace account id.
- cityIndustryType – Denotes the type of industry associated with the message. The values for this element must match codes from the CityIndustry code table.
- relatedID – Refers to the id of an underlying entity in the remote system to which the message refers. For example, if the message concerns a payment then the related ID identifies the ID of the payment within the remote system.
- externalCitizenMessageType – The external citizen message type, taken from the ExternalCitizenMessageType codetable.
- messageTitle – The title of the message. It is the responsibility of the remote system to localize this to the locale of the end user.
- messageBody – The body of the message. It is the responsibility of the remote system to localize this to the locale of the end user.
- effectiveDate – Optional. The date from which the message is effective. It will only be displayed from this date onwards. The date must be in the format – "YYYY-MM-DD". If an effective date is not provided then the current date is taken as the effective date.
- expiryDate – The date that the message is set to expire. Following this date, the message will not be displayed to the user. The date must be in the format – "YYYY-MM-DD".
- priority – A boolean value to indicate whether this message is a high priority.
Some messages are designed such that a newer message can replace an older one. For example, a message is sent concerning a meeting. The time of the meeting changes and a new message is sent with the updated time for the meeting. The client does not see both messages, rather the second message replaces the first and only the second message is seen. One external message will automatically replace another external message if the following fields match those of an existing message: sourceSystem, externalCitizenMessageType and relatedID.