...
This action returns an object of type ApplicationStatusResult. Helper methods exposed by this object can be used to map the result to relevant outcomes based on business requirements. The table below describes all helper methods that can be invoked on this result object with a description of the return value for each of these methods.
| Helper method | return type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| getApplicationStatusOutputExceptionIfNull() | GetApplicationStatusOutput (package path: dk.ekspresbank.feedbackservice._2014._01) | Returns a reference to the actual result object returned by the FeedbackService.getApplicationStatus call. This object can be used in case the helper methods available in ApplicationStatusResult object are not enough to meet the requirements. This method throws a RuntimeException if the GetApplicationStatusOutput object returned by FeedbackService.getApplicationStatus call is null. All the helper methods describes described in the next rows of this table are actually calling the corresponding getter methods on this GetApplicationStatusOutput object. Some times the helper methods perform some internal conversions/formatting for easy use. For ex:
| ||||||||||||||||||||||||||||||
| isStatusResultOk() | boolean | true: The currentStatus and latestEvent value in the response can be trusted false: Something went wrong, so the response values cannot be trusted | ||||||||||||||||||||||||||||||
| isHasGoAhead() | boolean | true/false Returns the value of hasGoAhead property | ||||||||||||||||||||||||||||||
| isHasShipped() | boolean | true/false Returns the value of hasShipped property | ||||||||||||||||||||||||||||||
| getRequestId() | String | Returns the requestId returned by Ekspresbank in getApplicationStatus response | ||||||||||||||||||||||||||||||
| getApplicationGuid() | String | Returns the applicationGUID returned by Ekspresbank in getApplicationStatus response. This will be same as the applicationGUID supplied in the input | ||||||||||||||||||||||||||||||
| getApplicationId() | Integer | Returns the applicationId returned by Ekspresbank in getApplicationStatus response. | ||||||||||||||||||||||||||||||
| getCurrentStatus() | Integer | Gets the Current status of the application. Below is a list of all possible values for CurrentStatus:
| ||||||||||||||||||||||||||||||
| getCurrentStatusDate() | Date | Date on which the application reached current status | ||||||||||||||||||||||||||||||
| getLatestEvent() | Integer | Gets the value of the latestEvent. Below is a list of all possible values for latestEvent property:
| ||||||||||||||||||||||||||||||
| getLatestEventDate() | Date | Returns the date of latestEvent | ||||||||||||||||||||||||||||||
| getContractUrl() | JAXBElement<String> | Gets the value of the contractUrl |
...
This action returns an object of type CancelResult. Helper methods exposed by this object can be used to map the result to relevant outcomes based on business requirements. The table below describes all helper methods that can be invoked on this result object with a description of the return value for each of these methods.
| Helper method | Return type | Description |
|---|---|---|
| getPutEventRecordOutputExceptionIfNull() | PutEventRecordOutput (package path: dk.ekspresbank.feedbackservice._2014._01) | Returns a reference to the actual result object returned by the FeedbackService.putEventRecord call. This object can be used in case the helper methods available in CancelResult object are not enough to meet the requirements. This method throws a RuntimeException if the PutEventRecordOutput object returned by FeedbackService.putEventRecord call is null. All the helper methods described in the next rows of this table are actually calling the corresponding getter methods on this PutEventRecordOutput object. Some times the helper methods perform some internal conversions/formatting for easy use. For ex:
|
| isCancelResultOk() | boolean | true: The response values can be trusted false: Something went wrong, so the response values cannot be trusted |
| getRequestId() | String | Returns the requestId returned in FeedbackService.putEventRecord call for cancel action |
If anything unexpected happens, an exception is thrown. It is possible to map an Exception to an outcome on the Action GUI on the workflow builder.
...
This action returns an object of type CaptureResult. Helper methods exposed by this object can be used to map the result to relevant outcomes based on business requirements. The table below describes all helper methods that can be invoked on this result object with a description of the return value for each of these methods.
If anything unexpected happens, an exception is thrown. It is possible to map an Exception to an outcome on the Action GUI on the workflow builder.
4 - Return Codes
ReturnCode | Description |
|---|---|
OK | Everything is ok, no errors. |
ERROR_LOGIN_ERROR | Something is wrong with the RetailerId/Password combination. |
ERROR_APPLICATION_NOTFOUND | Application identified by RetailerId/OrderNr not found. |
ERROR_UNKNOWN_ERROR | Unexpected error occurred. |
ERROR_APPLICATION_ALREADY_SUBMITTED | There is already a submitted application with the given OrderNr. |
ERROR_MANDATORY_FIELDS_MISSING | Not all mandatory fields were provided for the requested operation. |
ERROR_SITE_DISABLED | The site is disabled. |
ERROR_INVALID_PREFILLABLE_FIELDS | There are either non-prefillable fields available, or the value of some |
ERROR_INVALID_HASH | The hash of the fields is invalid. |
...
| Helper method | Return Type | Description |
|---|---|---|
| getPutEventRecordOutputExceptionIfNull() | PutEventRecordOutput (package path: dk.ekspresbank.feedbackservice._2014._01) | Returns a reference to the actual result object returned by the FeedbackService.putEventRecord call. This object can be used in case the helper methods available in CancelResult object are not enough to meet the requirements. This method throws a RuntimeException if the PutEventRecordOutput object returned by FeedbackService.putEventRecord call is null. All the helper methods described in the next rows of this table are actually calling the corresponding getter methods on this PutEventRecordOutput object. Some times the helper methods perform some internal conversions/formatting for easy use. For ex:
|
| isCaptureResultOk() | boolean | true: The response values can be trusted false: Something went wrong, so the response values cannot be trusted |
| getRequestId() | String | Returns the requestId returned in FeedbackService.putEventRecord call for capture action |
If anything unexpected happens, an exception is thrown. It is possible to map an Exception to an outcome on the Action GUI on the workflow builder.
4 - Logging
The project uses the rator-soap-monitoring to log request and response to the SOAP_CLIENT_LOG table. In order for this logging to work, two parameters must be added to the parameter tree. See section Configuration.
...
5 - Configuration
The table below describes all parameter tree entries that are used for Ekspres Bank API integration. All parameters except the logging related parameters are brand-enabled.
...
| Parameter Path/Type | Mandatory? | Value | Description |
|---|---|---|---|
| SOAP.MONITORING.ENABLE_RATOR_MONITORING_HANDLER | |||
| String | YES | T | Enables logging to SOAP_CLIENT_LOG table |
| SOAP.MONITORING.ENABLE_XML_PERSISTENCY | |||
| String | YES | T | Enables logging of request and response XMLs along with other basic logging info. If this is set to false, the SOAP XMLs will not be logged. |
...
6 - Version
Version | Released | Changes |
|---|---|---|
| 2.0 | xx-10-2016 | The Ekspres Bank Integration project is updated to integrate to New API of Ekspres Bank. The Ekspres Bank has moved to a new API, and this is different from old API that there are changes in input parameters and output parameters and request response types. So we have developed new Workflow Actions. The old Actions/Components are no longer available. |
1.1 | 12-09-2013 15:51:13 | Fixed an issue where request response was stored in soap_monitoring. It will now store it in soap_client_log |
1.0 | First stable release |
.putEventRecord