Page History

Use Case

The This example demonstrates the way an API response can be customized based on the client requirements. It speaks about The JSON below is a web service that returns address of branch as shown in JSON belowa branch office address.

{"id":102,"name":"Border","streetAddress":"123 MG Road","city":"Banglore","state":"KN","zipCode":"500050"}

The requirement is to customize this the response so that it does not contain the ID, then JSON elements must be named 'BranchName' instead of name and Location as a combination of streetAddress, city and State. The expected response is as given below. 

{
"BranchName":"Border",
"Location":"123 MG Road,Banglore, KN"
}

...

• Assign Variable Policy - to parse the response from the Target Server and define variables corresponding to different parts, added add in the scope TARGET_RESPONSE.
• Build Message Policy - to customize the JSON returned by the API and to include part of the original request, added add to the scope PROXY_RESPONSE.

Steps to achieve the Use Case

...

The variables populated in the step above is are used to build/customize the response from the proxy server. The payload is modified using the Build Message policy. The configuration looks as shown in the figure is displayed below.