This outbound web service is invoked by Universal Access on remote systems. It is used by clients to withdraw an application that they have previously submitted using the Receive Application Service. WSDL describing this service can be found in <CURAM_DIR>\EJBServer\components\WorkspaceServices\axis\ProcessApplicationService\ProcessApplicationService.wsdl. A web service request of this type contains the following information:
- applicationReference – A unique reference for the application to be withdrawn. This refers to the id transmitted with the Receive Application service request.
- programTypeReference – A reference that identifies the program being withdrawn. Each program type is referred to by a unique reference. This corresponds to the value of the Reference field configured in the Programs section of Universal Access configuration. For example "CashAssistance".
- requestSubmittedDateTime – A timestamp indicating when the request was submitted in XML Schema dateTime format. For example, 2012-05-29T15:34:49.000+01:00
- withdrawalRequestReason – The value is taken from the code table WithdrawalRequestReason. Values for this code table are
- WRES1001 – Attained employment
- WRES1002 – Change of circumstances
- WRES1003 – Filed in error
- withdrawalRequestID – An id that uniquely identifies this withdrawal request from the sending instance of Universal Access.
- senderIdentification – Identifies the sender of the request. The sender identification contains two parts, 1) the identifier of the system from which the request originates, 2) The Citizen Workspace Account ID of the user that created the request.
- supplementaryInformation – optional, reserved for future use.
The expected result following successful processing is a receiveWithdrawalRequestResponse as follows:
<receiveWithdrawalRequestResponse>
<result>true</result>
</receiveWithdrawalRequestResponse>
The service implementation should return a fault if there is an error processing the request. The fault string should be localized to the locale of the Universal Access Server since it will appear in the server log files. Some problems that may arise include:
- A withdrawal request with the given ID has already been sent by the given instance of Universal Access.
- The application reference referred to is not recognised as an application previously transmitted in a Receive Application service invocation from the same Universal Access instance.
The withdrawal request application is processed by the receiving agency after which a response should be sent in the form of a withdrawal request update. A sample SOAP request for this web service is published in Appendix A.