Path param based payment search/workflow(update)

Owned by Kaviyarasan P
Last updated: Jan 16, 2021 by Sathish P
1 min read

https://digit-discuss.atlassian.net/browse/RAIN-1810  

Update 1: Made backward compatible by config which can be enabled in the app props, which when made mandatory will request employees to use module-name in the URL path of payment search/workflow.

Update 2:  Applicable only for employees, citizens, and system users (default anonymous user used by the system for open URLs)  will have access by default.

is.payment.search.uri.modulename.mandatory=true

 

CANCEL payment - UPDATE API (_workflow) and _search API backend changes 

The payment APIs consisting of _search and _workflow(update API) are requested by the product team to be mapped only for the employees belonging to the respective roles associated with particular modules. To accommodate these changes an extra parameter denoting the module code had been added to the existing payment API URLs.

 

They are as follows

collection-services/payments/_search

collection-services/payments/{moduleCode}/_search

 

collection-services/payments/_workflow

collection-services/payments/{moduleCode}/_workflow

 

The values can be implemented as - 

collection-services/payments/PT/_search

collection-services/payments/WS/_search

 

collection-services/payments/PT/_workflow

collection-services/payments/WS/_workflow

 

The output of the changes:

  1. After the changes, the URLs should be constructed based on the module code and to be updated in the role action config. Any places where payment search and update API calls are made outside the network should add role action mappings as mentioned above.

  2. Any modules making use of the payment search APIs internally should make these changes in their configurations.

 

Currently, modules would be affected for internal usage - 

BPA-services

Pt-calculator-v2

Sw-services

Ws-services

The app.props have been updated in the code (develop branch - till spring release on dec-2020), the same should be changed if the values have been overridden in the deployment configs.