18.2 Synchronous Dispatch API Specification
This topic provide information about the Synchronous Dispatch API Specification.
Dispatch endpoint is the single entry-point for invoking the routes configured in Oracle Banking Routing Hub for services of a Service Consumer.
Dispatch Endpoint signature -
- Method: POST / GET
- Path: /route/dispatch
- Headers:
- appId : CMNCORE
- entityId : DEFAULTENTITY
- userId : <user id>
- branchCode : <branch code>
- Authorization : Bearer <Token>
- SERVICE-CONSUMER : <name of service consumer>
- SERVICE-CONSUMER-SERVICE : <name of service consumer service>
- Request Body:
- Any valid JSON/XML payload or multipart request which shall act as input to the transformation template in request transformer.
- Response
Body:
{ "data": {} "messages": {} }- If the route invocation succeeds, data JSON member would contain the transformed (optional) response of the provided service. If it is a provided web service and no response transformation template is supplied, XML Soap Body of response would be converted into JSON object and sent in data JSON member.
- If the route invocation fails due to misconfigured route or connection time out to ServiceProviderImpl or some other reason, relevant error messages would be sent in messages JSON member. In that case, data JSON member would be null or empty.
Examples: Refer the below screenshots of route dispatch for Service-Consumer Oracle_Service_Consumer and Service-Consumer Service List_Facilities.
Figure 18-6 Response Payload on Successful Dispatch
Figure 18-7 Response Payload on Failed Dispatch
